Business objects PRINTFORM 7.90C User Manual

Business Process BI Services Guide

Patents

Business Objects owns the following U.S. patents, which may cover products that are offered and sold by Business Objects: 5,555,403, 6,247,008 B1, 6,578,027 B2, 6,490,593 and 6,289,352.

Trademarks

Third-party contributors

Business Objects, the Business Objects logo, Crystal Reports, and Crystal Enterprise are trademarks or registered trademarks of Business Objects SA or its affiliated companies in the United States and other countries. All other names mentioned herein may be trademarks of their respective owners.

Business Objects products in this release may contain redistributions of software licensed from third-party contributors. Some of these individual components may also be available under alternative licenses. A partial listing of third-party contributors that have requested or permitted acknowledgments, as well as required notices, can be found at:

http://www.businessobjects.com/thirdparty

Chapter 1 Start Here 7

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Chapter 2 Overview of Business Process BI Services 9

What are Web Services? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Web Service Description Language (WSDL) . . . . . . . . . . . . . . . . . . . . 11

How do web services work? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

How are web services used in a Business Process Management

Environment? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

The extranet effect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

The next step: the web service . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Going further: collaboration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Introduction to Business Process BI Services . . . . . . . . . . . . . . . . . . . . . . 15

The services provided by the Business Process BI Services . . . . 15

Setting up Business Process BI Services . . . . . . . . . . . . . . . . . . . 18

Chapter 3 WSDL Reference 21

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

WSDL document example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

WSDL document structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

operations and messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

portType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

About namespaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Business Process BI Services and the WSDL document . . . . . . . . . . 27

Business Process BI Services Guide 3

Contents

BISecurity service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

BISecurity types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

BISecurity simple types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

BISecurity complex types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

BISecurity operation and messages . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

BISecurity ports and binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

BISecurity port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

BISecurity bindings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

BISecurity service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

BISecurity namespace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

BIWorkflow service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

BIWorkflow types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

BIWorkflow simple types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

BIWorkflow complex types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

BIWorkflow operations and messages . . . . . . . . . . . . . . . . . . . . . . . . . 73

GetDocumentURL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

SendDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

EmailDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

PrintDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

RefreshDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

CheckRefreshStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

FireEvents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

BIWorkflow ports and binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

BIWorkflow service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

BIWorkflow namespace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Chapter 4 Tutorial 93

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

Preconditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

Learning Objective . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

Deploying the war file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Setting up the BISecurity service in the BPM tool . . . . . . . . . . . . . . . . . . . . 96

Setting up the BIWorkflow service in the BPM tool . . . . . . . . . . . . . . . . . . . 97

4 Business Process BI Services Guide

Contents

Aligning your business process with the Business Process BI Services . . 98

Enabling Clustering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

Using the Business Process BI Services Logger . . . . . . . . . . . . . . . . . . . 107

Chapter 5 Get More Help 109

Index 111

Business Process BI Services Guide 5

Contents

6 Business Process BI Services Guide

Business Process BI Services Guide

Start Here

chapter

Star t Here

Overview

This guide shows you how to integrate Business Process BI Services into your existing business process. The operational BI components are standalone services that use BusinessObjects Enterprise to perform Business Intelligence. By integrating Business Process BI Services into your existing Business Process Execution Language (BPEL) workflow, you maintain the flexibility of a service-oriented architecture.

This guide provides the high-level rationale behind Business Process BI Services, and describes how to use it effectively. It includes tutorials and WSDL references that will help you to integrate the Business Process BI Services into your existing workflow.

Start using the Business Process BI Services Guide

Overview of Business Process BI Services

Gain an understanding of web services, its background and an overview of the services provided by the Business Process BI Services.

WSDL Reference

Browse the API documentation, understand the common workflow scenarios and view code samples.

Tutorial

Learn how to set up the development environment and read task-based step procedures.

Get More Help

Links to technical support and additional developer resources.

8 Business Process BI Services Guide

Overview of Business Process BI Services

chapter

Overview of Business Process BI Services

What are Web Services?

In today’s Business Intelligence (BI) marketplace, the importance of sharing information with customers and suppliers is growing. Many companies now understand that their value takes into account not only financial considerations, but also those that are less easy to measure, such as customer satisfaction, employee satisfaction, and supply chain efficiency.

The need is growing, therefore, for information about these other indicators to be made publicly available. At the same time, it is increasingly becoming recognized that there is value in sharing this information with third parties, or internally within a company via an intranet. This has already been demonstrated in the growth of BI extranets, but even so, the industry is demanding even more transparency. BI web services represent the next stage in sharing Business Process Management information. Business Process Management involves the designing, executing, monitoring and optimizing of the cross-functional business activities that incorporate people, processes and systems. Business Process Models (BPM) facilitate the restructuring of activities and information that an enterprise needs to achieve for its business goals. For the business process modeler, the BusinessObjects Business Process BI Services is a way to leverage the functionality of BusinessObjects Enterprise without being confined to one particular system.

Also, should your business processes change, you have the flexibility to refactor web service interactions and relationships. The underlying Service Oriented Architecture (SOA) model exposes the functionalities of business applications through self-contained web services. SOA is widely used and it is the cornerstone of BPM, therefore Business Process BI Services leverage the decision centric nature of Business Process Management.

What are Web Services?

Web services are a means of enabling applications to connect and interact over the web. Web services comprise of client(s) that are consumers of resources and server(s) that provide resources. The client(s) and server(s) in a web service are often times remotely located. Web services allow platformindependent interaction of applications distributed over a network. They represent the next step in the evolution of the process of sharing information over a network, such as the Internet, an intranet or an extranet.

10 Business Process BI Services Guide

Overview of Business Process BI Services

Web Service Description Language (WSDL)

One of the most important concepts of web services is interoperability. The API and protocol used to invoke web services have become recognized standards; this means that any web service can talk to any consumer without needing to know what language each is written in or what operating system each is running on. A web service consumer might be:

• A web site (on either a desktop or wireless browser)

• An application program, such as Microsoft Office 2003

• Another web service

• A Business Process Management tool

The XML-based Web Service Description Language (WSDL) defines the interface of a web service and how each service communicates with each other. WSDL can be seen as metadata in that it does the following:

• describes the web service

• specifies its location

• describes the operations it exposes

How do web services work?

The sharing of information between companies over web services involves the following steps:

• Company A provides a web service using one of the following methods:

• Sending the URL for its web service to the consumers.

• Publishing information to a Universal Description, Discovery and

Integration (UDDI) directory.

• Company B, the consumer, subscribes to Company A’s published web

services.

• Company A sets up a security profile for Company B, and sends

Business Intelligence at Company B’s request, using SOAP.

• Optionally, Company B can subscribe to the BI web services provided by

multiple partners and can combine all of this external Business Intelligence with their own, internal, information.

In this way, Company B can access production information from Company A, inventory information from Company C and sales information from Company D. In turn, it can make some or all of this information available to its customers.

Business Process BI Services Guide 11

Overview of Business Process BI Services

How do web services work?

How are web services used in a Business Process Management Environment?

Web services enable Business Intelligence systems to extend the accessibility of information beyond the constraints and boundaries of an individual enterprise and the extranet. By using web services, BI systems in a BPM environment, can be networked together to enable applications to share information with each other in an easier manner. These networked BI systems that make use of web services improve efficiency and enable businesses to make more sense of their data.

The extranet effect

The diagram below illustrates a typical extranet deployment.

Consumer

HTML

Browser

Substantial benefits accrue from setting up BI extranets with their customers, partners, and suppliers. These benefits include:

• More efficient supply chains.

• More effective partnerships.

• New revenue opportunities.

• Increased customer satisfaction and loyalty.

The next step: the web service

The web service model is ideal for a highly distributed, Service Oriented Architecture (SOA). This simplifies deployment because you may decide which service you want to deploy. It also streamlines the object models as you may have one for each service. Building new services and adding composite services are often easier for web services than in legacy systems because they rely on the SOA paradigm.

Supplier

HTML

Internet

BusinessObjects Enterprise server

12 Business Process BI Services Guide

Overview of Business Process BI Services

How do web services work?

The diagram below illustrates a typical web services deployment.

Supplier

XML

Browser

Consumer

Web Site

Application

XML

Web Server

Internet

XML

Business Intelligence Web Services

Extending these BI extranets as web services offers further benefits:

• Easier customization to fit your extranet customers’ look and feel.

• Your extranet customers can integrate your extranet into their intranet.

• Your extranet customers can combine Business Intelligence from your

extranet with their own Business Intelligence.

Business Process BI Services Guide 13

Overview of Business Process BI Services

How do web services work?

Going further: collaboration

The diagram below illustrates a possible extended network deployment.

Internal Application

Business Intelligence Web Services

Intranet

Consumer

Applications

Supplier

Business Intelligence Web Services

Internet

Business Intelligence Web Services

Because web services are a two-way arrangement, not only can you enable your own extranets to make them available to others, you can also take advantage of those of your partners doing the same thing. Integrating your partners’ BI extranets via web services means that:

• You control how the BI extranet is integrated into your own environment.

• You can combine Business Intelligence from multiple extranets.

• You can integrate Business Intelligence from your partners’ extranets

with your own.

14 Business Process BI Services Guide

Overview of Business Process BI Services

Introduction to Business Process BI Services

Business Process BI Services are web service applications that let you quickly and easily integrate BusinessObjects Enterprise technology with your customized web-based applications. The web services can integrate BusinessObjects Enterprise administration into common IT processes, provide business intelligence information delivery, and automate data refreshes. You can have the flexibility of a service-oriented architecture incorporated into your existing Business Process Modeling (BPM) workflow.

The services provided by the Business Process BI Services

Business Process BI Services provides integration points to add business intelligence and platform administration functionality to a BPM environment. The integration points provide services for retrieving information and managing user access.

Business Process BI Services simplifies business intelligence workflows that use BPEL engines and BPM tools. Multi-stepped workflows are replaced with a single-service method, and the complexity of incoming messages is greatly reduced.

Business Process BI Services consists of two web services:

• BISecurity service

• BIWorkflow service

The BISecurity Service

The BISecurity service provides secure logon access to BusinessObjects Enterprise. It also lets you manage user accounts and map new BusinessObjects Enterprise users to tasks within BPEL processes.

The following is a list of features added to external BPEL processes by the BISecurity service:

• Create a long running security asset that can be passed across different

modules of the Business Process BI Services, without having to log on again, provided the asset is valid.

• Invalidate a security asset.

• Authenticate a BusinessObjects Enterprise user using all authentication

types supported by BusinessObjects Enterprise including types available through integration kits.

• Control the lifespan of a security asset by specifying the following:

• The hosts for which the asset is valid.

• The lifespan of asset in minutes.

Business Process BI Services Guide 15

Overview of Business Process BI Services

Introduction to Business Process BI Services

• The number of allowed logons for a given asset.

Note: For more information about BISecurity methods, and for the workflow

specification, see the BISecurity service section in the WSDL Reference.

The BIWorkflow Service

The BIWorkflow service exposes the following BI Platform operations:

• GetDocumentURL

This feature combines BusinessObjects Enterprise document retrieval and URL generation into a unified process.

• Refresh document

This feature lets external BPEL processes refresh data in a BusinessObjects Enterprise document, creating a new document instance. The refresh document feature exposes supported data refresh options using the declarative nature of WSDL. Refresh document supports a number of delivery options including the generation of document URLs, delivery by email, saving to file, and printing.

Note: Refresh document supports most scheduling options except firing

and waiting for BusinessObjects Enterprise events.

• EmailDocument

This feature retrieves a BusinessObjects Enterprise document and generates a document URL, allowing more flexibility for specifying documents. Email document exposes the OpenDocURL document viewing API to the process modeler. The email feature encapsulates several parameters that are supported by the opendoc URL view API, and it exposes the supported parameters using WSDL.

The following is a list of features added to external BPEL processes by the email document feature:

• Specify email recipient(s) to receive newly created document

instances through document refresh.

• Use one or more email recipients.

• Mail new document instances as an email attachments.

16 Business Process BI Services Guide

Overview of Business Process BI Services

Introduction to Business Process BI Services

• SendDocument

This feature delivers newly created document instances. It lets the newly created document instance be sent as a file to a location specified by the caller.

• PrintDocument

This feature sends the newly created document instance to the specified printer.

• FireEvents

This feature fires custom BusinessObjects Enterprise events within a BPEL process. Events can be specified by human readable name or unique BusinessObjects Enterprise ID. Processes can fire more than one event within a single service call.

Note: For more information about the BIWorkflow methods, and for the workflow

specification, see the BIWorkflow service section in the WSDL Reference.

The Business Process BI Services clustering feature

The Business Process BI Services also lets you deploy web services in a clustered configuration. By deploying Business Process BI Services with clustering enabled, your web service benefits from greater scalability and failover.

Note: Clustering is also known as Web Farms.

To enable clustering, see the Enabling Clustering section in the Tutorial chapter.

The following diagram illustrates a typical clustered deployment:

Business Process BI Services Guide 17

Overview of Business Process BI Services

Introduction to Business Process BI Services

The Business Process BI Services Logger

Business Process BI Services can log and debug messages. Basic logging is enabled by default, but you can set more detailed levels of logging. After a log file reaches the maximum allowed size, it is appended with a numerical suffix, and then a new log file is started. A maximum of nine log files are archived before the oldest file in the archive is overwritten by the latest archived file.

Four levels of detail for logging are available:

• Basic: This is the default level enabled for Business Process BI Services.

• Advanced: This level can provide more detailed explanations of the

issues being logged.

• Detailed: This level allows some debugging information to be included in

the log file.

• Verbose: This level allows all messages to be included in the log file.

For more information about how to locate log files, change the location of log files, configure the Business Process BI Services logger, use a different predefined logging level, or to create your own logging level, see the Using the

Business Process BI Services Logger section in the Tutorial chapter.

Setting up Business Process BI Services

Business Process BI Services transfer Business Intelligence information such as Web Intelligence, Desktop Intelligence, and Crystal reports between networks over the web.

Business Objects web services is deployed in two parts: the server and the consumer. On the server side, Business Objects web services is deployed with the BusinessObjects Enterprise servers. In the consumer part, the Consumer remote API lets consumers create customized web sites, applications, or web services that access BusinessObjects Enterprise functionality. The Consumer remote API is a series of web-based operations based on the J2EE framework.

Business Process BI Services transfer Business Intelligence information such as Web Intelligence, Desktop Intelligence, and Crystal reports between networks over the web.

Note: For more information about the Consumer, see the Business Objects

web services Developer's Guide.

18 Business Process BI Services Guide

Overview of Business Process BI Services

Introduction to Business Process BI Services

Consumer side

Consumer.NE T Application

Internet

Intranet

Consumer J2EE Application

BusinessObjects Enterprise server

Server side

Business Objects web services

Database

For more information on setting up the standalone WAR and to learn how to integrate a business process model with the Business Process BI Services, see the Tutorial.

Business Process BI Services Guide 19

Overview of Business Process BI Services

Introduction to Business Process BI Services

20 Business Process BI Services Guide

Business Process BI Services Guide

WSDL Reference

chapter

WSDL Reference

Overview

WSDL

This section describes the structure of a Web Services Description Language (WSDL) document, and it explains the interfaces of the BISecurity and BIWorkflow services. This section also contains workflow specifications for the operations enclosed within the BISecurity and BIWorkflow services.

Click the appropriate link to go to that section:

• WSDL

• Definition

• WSDL document example

• WSDL document structure

• Business Process BI Services and the WSDL document

• BISecurity service

• BIWorkflow service

Definition

Web Services Definition Language (WSDL) is an XML format for describing the syntax of Web Services interfaces and their locations.

WSDL document example

<?xml version="1.0"?> <definitions name="StockQuote" targetNamespace="http://

example.com/stockquote.wsdl" xmlns:tns="http:// example.com/stockquote.wsdl" xmlns:xsd1="http:// example.com/stockquote.xsd" xmlns:soap="http:// schemas.xmlsoap.org/wsdl/soap/" xmlns="http://

schemas.xmlsoap.org/wsdl/"> <types> <schema targetNamespace="http://example.com/

stockquote.xsd" xmlns="http://www.w3.org/2000/10/

XMLSchema"> <element name="PriceRequest"> <complexType> <all> <element name="tickerSymbol"

type="string"/> </all> </complexType> </element>

22 Business Process BI Services Guide

WSDL Reference

WSDL

<element name="Price"> <complexType> <all> <element name="price" type="float"/> </all> </complexType> </element> </schema> </types> <message name="GetLastPriceInput"> <part name="body" element="xsd1:PriceRequest"/> </message> <message name="GetLastPriceOutput"> <part name="body" element="xsd1:Price"/> </message> <portType name="StockQuotePortType"> <operation name="GetLastPrice"> <input message="tns:GetLastPriceInput"/> <output message="tns:GetLastPriceOutput"/> </operation> </portType> <binding name="StockQuoteSoapBinding"

type="tns:StockQuotePortType">

<soap:binding style="document" transport="http://

schemas.xmlsoap.org/soap/http"/> <operation name="GetLastPrice"> <soap:operation soapAction="http://example.com/

GetLastPrice"/> <input> <soap:body use="literal"/> </input> <output> <soap:body use="literal"/> </output> </operation> </binding> <service name="StockQuoteService"> <documentation>My first service</documentation> <port name="StockQuotePort"

binding="tns:StockQuoteBinding"> <soap:address location="http://example.com/

stockquote"/> </port> </service> </definitions>

WSDL document structure

A WSDL document is a set of definitions that describe network services. This section describes the elements contained in a WSDL document.

• types

The types element is a container for data type definitions.

Business Process BI Services Guide 23

WSDL Reference

WSDL

types

• message

The message element is an abstract, typed definition of the elements of an operation.

• operation

The operation element is an abstract description of an action supported by a service.

• portType

The portType element is an abstract set of operations supported by one or more endpoints.

• binding

The binding element is a protocol and data format specification for a port type.

• services

The services element is a collection of endpoints.

The types element contains data definitions that the exchanged messages use.

Syntax:

<types>

<xsd:schema .... />

</types> </definitions>

A WSDL Schema contains types that are either simple or complex.

Simple types

Simple types cannot have attributes or child elements between the opening and closing tags of the element.

Example:

<s:simpleType name="HeaderFooterOptionEnum"> <s:restriction base="s:string"> <s:enumeration value="NONE" /> <s:enumeration value="ONCE" /> <s:enumeration value="EACH_PAGE" /> </s:restriction> </s:simpleType>

24 Business Process BI Services Guide

WSDL Reference

WSDL

Complex types

Complex types are made up of attributes, other elements, and a mixture of elements and text. The complex type can define the number of possible occurrences for each of these elements with the maxOccurs and minOccurs attributes. The maxOccurs attribute specifies the maximum number of occurrences for an element, while the minOccurs attribute specifies the minimum number of occurrences for an element.

Example:

<s:complexType name="LogonInfo">

<s:sequence> <s:element name="AuthenticationType"

type="s:string" minOccurs="1"/>

<s:element name="AccountName" type="s:string"

minOccurs="1"/>

<s:element name="Password" type="s:string"

minOccurs="1"/>

<s:element name="Domain" type="s:string"

minOccurs="1"/>

<s:element name="Locale" type="s:string"

minOccurs="0"/>

<s:element name="TimeZone" type="s:string"

minOccurs="0"/>

/s:sequence>

</s:complexType>

operations and messages

The operation element is a set of input and output messages. An operation within a binding element specifies binding information for the operation in the portType element of the binding element. It looks within the portType for an operation of the same name.

The message element is a collection of data fields that is exchanged between web service providers and consumers. The message element consists of one or more logical parts.

Syntax:

The message name attribute provides a unique name among all messages defined within the WSDL document. The part name attribute provides a unique name among all the parts of the enclosing message.

Business Process BI Services Guide 25

WSDL Reference

WSDL

portType

binding

The portType element is a named set of operations and messages. A portType component describes a set of messages that a service sends or receives.

Syntax:

<wsdl:definitions .... >

<wsdl:portType name="nmtoken">

<wsdl:operation name="nmtoken" .... />

</wsdl:portType> </wsdl:definitions>

The port type name attribute provides a unique name among all port types defined within the enclosing WSDL document.

The binding element defines message format and protocol details for operations and messages defined by a portType element. Any number of bindings for a given portType element is permitted.

Syntax:

<wsdl:definitions .... >

<wsdl:binding name="nmtoken" type="qname"> <-- extensibility element (1) --> <wsdl:operation name="nmtoken"> <-- extensibility element (2) --> <wsdl:input name="nmtoken"? > <-- extensibility element (3) --> </wsdl:input> <wsdl:output name="nmtoken"? > <-- extensibility element (4) --> </wsdl:output> <wsdl:fault name="nmtoken"> <-- extensibility element (5) --> </wsdl:fault> </wsdl:operation> </wsdl:binding> </wsdl:definitions>

The name attribute provides a unique name among all bindings defined within the WSDL document.

services

The service element will group a set of related ports.

Syntax

<wsdl:definitions .... >

<wsdl:service name="nmtoken">

<wsdl:port .... />

</wsdl:service>

26 Business Process BI Services Guide

WSDL Reference

BISecurity service

</wsdl:definitions>

About namespaces

A namespace is a unique URI identifier that is used to qualify a set of XML elements and attributes. WSDL relies on the semantics defined by XML. XML documents can use elements and attributes defined in other XML documents. Namespaces help in recognition of elements and attributes from a specific XML document. They also help avoid collision of names when two or more XML documents use the same name for an element or attribute.

Business Process BI Services and the WSDL document

BPEL supports only a subset of the WSDL language for the services it consumes. For example, it does not support inheritance of complex XML types. Business Process BI Services provides two web services that meet this requirement:

• BISecurity service – Exposes operations for authentication for user

logons and simple administration.

• BIWorkflow service – Exposes BusinessObjects Platform operations

such as refreshing document data, triggering events, and so on.

Note: Platform Web Service SDK provides a wider suite of operations but

does not conform to a subset of the WSDL language required by BPEL. To learn how to have access to a wider range of functionalities, see the Platform

Web Services Software Development Toolkit User Guide.

BISecurity service

The BISecurity exposes the following BusinessObjects Platform services:

• Session management

• User creation

BISecurity WSDL - types

Simple types

Simple Types Description

UserTypeEnum A string that represents the licensing scheme of

users, the value of which is constrained to be either NAMED or CONCURRENT.

Business Process BI Services Guide 27

WSDL Reference

BISecurity service

Complex types

Complex Types Description

AssetLifespanOptions Defines options to control the use and lifespan of a

security asset. A security asset is a text-based token representing a user’s security context (the user’s ability to access the system). The value is constrained to constants such as MaxLoginCount, ValidForHosts, and AssetDuration.

LogonInfo Defines options that specify logon information for

creating security assets. The value is constrained to constants such as Domain, Locale, TimeZone, and so on.

UserInfo Defines options for user creation. The value is

constrained to constants such as AccountName, Password, UserType, and so on.

UserSecuritySettings Defines constraints on password. The value is

constrained to constants such as PasswordNeverExpires, MustChangePassword, and CannotChangePassword.

BISecurity WSDL - operations and messages

Operations Messages

Input Output Fault

CreateSecurity Asset

CreateUser CreateUserIn CreateUserOut BISecurityException

DestroySecurity Asset

CreateSecurityA ssetIn

DestroySecurity AssetIn

BISecurity types

This section describes the simple and complex types defined in the BISecurity WSDL file.

BISecurity simple types

UserTypeEnum

A string that represents the licensing scheme of users, the value of which is constrained to be either NAMED or CONCURRENT.

28 Business Process BI Services Guide

CreateSecurityA ssetOut

DestroySecurity AssetOut

BISecurityException

Example

<s:simpleType name="UserTypeEnum">

<s:restriction base="s:string">

<s:enumeration value=""/>

<s:enumeration value="NAMED"/> <s:enumeration value="CONCURRENT"/>

</s:restriction> </s:simpleType>

BISecurity complex types

AssetLifespanOptions

Defines options to control the use and lifespan of a security asset. It defines the elements MaxLoginCount, ValidForHosts, and AssetDuration.

Example

<s:complexType name="AssetLifespanOptions">

<s:sequence>

<s:element name="ValidForHosts" type="s:string"

<s:element name="AssetDuration" type="s:int"

<s:element name="MaxLoginCount" type="s:int"

</s:sequence> </s:complexType>

Remarks

• MaxLoginCount represents the number of allowed logons using a

security asset. A security asset is used when Business Process BI

Services is deployed, and a new one is used when the old security asset

expires on that deployment.

• ValidForHosts represents the number of machines for which the security

asset is valid. This field can be specified multiple times in the

AssetLifespanOptions. If AssetLifespanOptions or the “ValidForHosts”

field is unspecified, the security asset is valid for all machines. You can

explicitly specify that the security asset must be valid for all machines by

setting the “ValidForHost” field to the empty string (“”). If the

“ValidForHosts” field is explicitly specified, it must be specified with the

empty string (“”), or the field must include the names of all machines

running the Business Process BI web service that the client could

possibly connect to.

minOccurs="1"/>

minOccurs="0"/>

WSDL Reference

BISecurity service

Business Process BI Services Guide 29

WSDL Reference

BISecurity service

• AssetDuration represents the duration in minutes for which an asset is

valid.

See also

UserSecuritySettings UserInfo LogonInfo BISecurity simple types CreateSecurityAsset

LogonInfo

Defines options that specify logon information for creating security assets. The value is constrained to constants such as Domain, Locale, TimeZone, and so on.

Example

<s:complexType name="LogonInfo">

<s:sequence>

s:element name="AuthenticationType" type="s:string"

minOccurs="1"/>

s:element name="AccountName" type="s:string"

minOccurs="1"/>

<s:element name="Password" type="s:string"

minOccurs="0"/>

<s:element name="Domain" type="s:string"

minOccurs="0"/>

<s:element name="Locale" type="s:string"

minOccurs="0"/>

<s:element name="TimeZone" type="s:string"

minOccurs="0"/>

<s:element name="SharedSecret" type="s:string"

minOccurs="0"/>

</s:sequence>

</s:complexType>

Remarks

• The AuthenticationType cannot be left blank. The AuthenticationType

accepts any one of the following values:

• secEnterprise (for BusinessObjects Enterprise Authentication),

• secWinAD (for Windows Active Directory Authentication),

• secLDAP (for LDAP server authentication).

• secEnterprise, secWinAD, or secLDAP authentication must be properly

configured on the Business Objects Enterprise system to enable log on. For more information about how to configure these authentication types, see to the BusinessObjects Enterprise Administrators Guide.

30 Business Process BI Services Guide

WSDL Reference

BISecurity service

• Domain indicates the CMS for which the security asset must be created.

• The format of Locale follows standard string formats for ISO Language

and Country codes. The string must be of the form XX or XX_YY.

Substitute XX for an ISO-639 language code and YY for an ISO-3166

country code.

For more information about language codes, see the ISO website.

Note: The Business Process BI Services only supports a subset of these

language codes. Please see the supported language documentation for

more information.

• The format of TimeZone also closely mimics that required by the Java

programming language. For more information about the Java API, see

the Sun Java website.

• If a SharedSecret field has been specified, the Password field can be left

blank. A Password does not need to be specified in the Password field for

successful authentication, if the value specified in the SharedSecret field

matches the shared secret configured on the target CMS. In case both

Password and SharedSecret have been specified, SharedSecret is

authenticated first. If the SharedSecret authentication fails, authentication

will be retried using the Password. For more information about how to

configure the CMS SharedSecret, see the BusinessObjects Enterprise

Deployment and Configuration Guide.

• Business Process BI supports Trusted Authentication. Trusted

Authentication allows a shared secret to be set between the web services

machine and a CMS. This configuration lets security assets be created

for the secEnterprise users without requiring a password. For more

information about how to configure Trusted Authentication, see the

BusinessObjects Enterprise Deployment and Configuration Guide.

See also

AssetLifespanOptions UserSecuritySettings UserInfo BISecurity simple types CreateSecurityAsset

UserInfo

Defines options for user creation. The value is constrained to constants such as Accountname, Password, UserType, and so on.

Example

<s:complexType name="UserInfo">

<s:sequence>

Business Process BI Services Guide 31

WSDL Reference

BISecurity service

<s:element name="AccountName" type="s:string"

minOccurs="1"/>

<s:element name="Password" type="s:string"

minOccurs="1"/>

<s:element name="UserType" type="s1:UserTypeEnum"

minOccurs="1"/>

<s:element name="FullName" type="s:string"

minOccurs="0"/>

<s:element name="EmailAddress" type="s:string"

minOccurs="0"/>

<s:element name="Description" type="s:string"

minOccurs="0"/>

<s:element name="UserSecuritySettings"

type="s1:UserSecuritySettings" minOccurs="0"/>

<s:element name="AddToUserGroups" type="s:string"

minOccurs="0" maxOccurs="unbounded"/>

</s:sequence>

</s:complexType>

Remarks

AddtoUserGroup allows users groups to be specified with varied privileges such as Administrative rights.

See also

AssetLifespanOptions LogonInfo UserSecuritySettings BISecurity simple types CreateSecurityAsset

UserSecuritySettings

Defines the constraints on password. The value is constrained to constants such as PaswordNeverExpires, MustChangePassword, and CannotChangePassword.

Example

<s:complexType name="UserSecuritySettings">

<s:sequence>

<s:element name="PasswordNeverExpires"

type="s:boolean" minOccurs="0"/>

<s:element name="MustChangePassword" type="s:boolean"

minOccurs="0"/>

<s:element name="CannotChangePassword"

</s:sequence>

</s:complexType>

32 Business Process BI Services Guide

type="s:boolean" minOccurs="0"/>

See also

AssetLifespanOptions LogonInfo UserInfo BISecurity simple types

BISecurity operation and messages

CreateSecurityAsset

This operation authenticates Business Objects Enterprise users and returns security assets for those users. A security asset is a text-based token representing a user’s security context (the user’s ability to access the system). Security assets are needed to use all other operations provided by the Business Process BI Services. Security assets also indicate which CMS the operations perform against. A security asset is valid within a particular time frame. It can be passed from one part of a business process to another or passed between different business processes. The same asset can be used repeatedly provided the security asset is valid. The text-based nature of an asset allows a BPEL process to use an asset with all modules of the Business Process BI Services that may be used in a long running process.

Example

<fault name="BISecurityException"

message="s1:FaultMessage"/>

</operation> <message name="CreateSecurityAssetIn"> <part element="s1:CreateSecurityAsset" name="parameters"/> </message> <message name="CreateSecurityAssetOut"> <part element="s1:CreateSecurityAssetResponse"

name="parameters" /> </message> <s:element name="CreateSecurityAsset"> <s:complexType> <s:sequence> <s:element minOccurs="0" name="LogonInfo"

type="s1:LogonInfo" /> <s:element minOccurs="0" name="AssetLifespanOptions"

type="s1:AssetLifespanOptions" /> </s:sequence> </s:complexType> </s:element> <s:element name="CreateSecurityAssetResponse"> <s:complexType> <s:sequence>

WSDL Reference

BISecurity service

Business Process BI Services Guide 33

WSDL Reference

BISecurity service

<s:element name="SecurityAsset" type="s:string" /> </s:sequence> </s:complexType> </s:element>

Message input

CreateSecurityAssetIn

LogonInfo [LogonInfo]

AssetLifespanOptions [AssetLifespanOptions]

Message output

CreateSecurityAssetOut

SecurityAsset[string]

34 Business Process BI Services Guide

WSDL Reference

BISecurity service

Remarks

The security context for a user represents the user’s ability to access the system with an asset until any one of the following conditions are met:

• The asset has expired.

• The asset has been destroyed.

See also

DestroySecurityAsset CreateUser AssetLifespanOptions LogonInfo UserInfo UserSecuritySettings

Workflow Specification for CreateSecurityAsset

Normal Scenario Workflow BPEL process sends a message to the

web service containing the following authentication information of the current process:

a. Authentication parameters such as username, password, domain/CMS, AuthenticationType.

b. Optional security parameters such as

AssetLifespanOptions, asset duration in

minutes, ValidForHosts, and valid number of logons.

The service authenticates the user using the authentication information.

Alternative Scenario Workflow Partial authentication information is

provided. The service authenticates using default

settings that are contained in a configuration file.

Error Scenario Authentication may fail due to invalid

information or non-existent account. The BusinessObjects Enterprise exception

is formatted to a suitable SOAP exception response message.

Business Rule The security asset represents the

authenticated user and acts as a ticket for retrieving one or more BusinessObjects Enterprise sessions.

Business Process BI Services Guide 35

WSDL Reference

BISecurity service

CreateUser

This operation adds a new BusinessObjects Enterprise user from within a BPEL process.

Example

<input message="s1:CreateUserIn"/> <output message="s1:CreateUserOut"/> <fault name="BISecurityException"

message="s1:FaultMessage"/> </operation> <s:element name="CreateUser">

<s:complexType> <s:sequence> <s:element minOccurs="1" name="SecurityAsset"

type="s:string"/>

<s:element minOccurs="1" name="UserInfo"

type="s1:UserInfo"/>

</s:sequence> </s:complexType> </s:element> <s:element name="CreateUserResponse"> <s:complexType> <s:sequence> <s:element name="UserID" type="s:int"/> </s:sequence> </s:complexType>

</s:element>

Message input

CreateUserIn

SecurityAsset [string]

UserInfo [UserInfo]

Message output

CreateUserOut

UserID [int]

Remarks

The user account must be new; it cannot already exist. Current security context must have administrative rights to the BusinessObjects Enterprise system to create a user account. For information about how to grant rights, see the BusinessObjects Enterprise Administrator’s Guide.

36 Business Process BI Services Guide

See also

CreateSecurityAsset DestroySecurityAsset UserSecuritySettings UserInfo LogonInfo

Workflow Specification for CreateUser

WSDL Reference

BISecurity service

Normal Scenario Workflow

Alternative Scenario Workflow

Error Scenario CreateUser returns an error message to the

BPEL process sends a message to the web service with valid user parameters.

The service then adds the user to the BusinessObjects Enterprise system with the specified options and attributes.

Not applicable.

calling process under these circumstances:

• The current security context has insufficient

rights to add new users to BusinessObjects Enterprise.

• The user groups specified are invalid.

• The password specified does not meet the

security criteria required by a security plugin.

• A duplicate account name exists.

Business Rule None.

DestroySecurityAsset

This operation invalidates or destroys a security asset. A business process is then unable to use the security asset to invoke Business Process BI operations.

Example

<input message="s1:DestroySecurityAssetIn"/> <output message="s1:DestroySecurityAssetOut"/> <fault name="BISecurityException"

</operation> <message name="DestroySecurityAssetIn">

</message>

message="s1:FaultMessage"/>

<part element="s1:DestroySecurityAsset"

name="parameters"/>

Business Process BI Services Guide 37

WSDL Reference

BISecurity service

<s:complexType>

<s:sequence>

<s:element name="SecurityAsset" type="s:string"/>

</s:sequence>

</s:complexType>

</s:element>

<s:element name="DestroySecurityAssetResponse">

<s:complexType>

<s:sequence/>

</s:complexType> </s:element>

Message input

DestroySecurityAssetIn

SecurityAsset [string]

Message output

DestroySecurityAssetOut

Remarks

• When a DestroySecurityAsset is called, CMS takes a few minutes before

it can invalidate the asset; therefore, after an asset has been destroyed, it

may still be accessible to the user for a short time.

• DestroySecurityAsset returns an error if the invalidated asset is used to

invoke methods of Business Process BI web service.

See also

CreateSecurityAsset BISecurity ports and binding CreateUser AssetLifespanOptions LogonInfo UserInfo UserSecuritySettings

38 Business Process BI Services Guide

Workflow Specification for DestroySecurityAsset

WSDL Reference

BISecurity service

Normal Scenario Workflow

Alternative Scenario Workflow

Error Scenario Not applicable.

Business Rule Invalidation or destruction of a security asset

BISecurity ports and binding

BISecurity port

The BISecurityPort defines the web service, the operations that can be performed, and the messages that are involved, which include CreateSecurityAsset, CreateUser, and DestroySecurityAsset. The port defines the connection point to the web service.

Example

<input message="s1:CreateSecurityAssetIn"/> <output message="s1:CreateSecurityAssetOut"/> <fault name="BISecurityException"

message="s1:FaultMessage"/>

</operation>

<input message="s1:DestroySecurityAssetIn"/> <output message="s1:DestroySecurityAssetOut"/> <fault name="BISecurityException"

message="s1:FaultMessage"/> </operation> <operation name="CreateUser">

<input message="s1:CreateUserIn"/> <output message="s1:CreateUserOut"/> <fault name="BISecurityException"

message="s1:FaultMessage"/> </operation>

</portType>

BPEL process sends a message to the web service containing the security asset to be invalidated.

If the asset is invalidated by a service, no response message is sent to caller.

The asset has already expired due to the constraints specified at the time of creation.

has no affect on an open BusinessObjects Enterprise Session.

Business Process BI Services Guide 39

WSDL Reference

BISecurity service

BISecurity bindings

See also

BISecurity operation and messages BISecurity types BIWorkflow service

The BISecurityBinding defines the message format and protocol details for operations and messages defined by the BISecurityPort.

Example

<soap:binding style="document" transport="http://

schemas.xmlsoap.org/soap/http"/>

<soap:operation soapAction="http://

bisecurity.dsws.businessobjects.com/2006/06/

01/CreateSecurityAsset" style="document"/> <input> <soap:body use="literal"/> </input> <output> <soap:body use="literal"/> </output> <fault name="BISecurityException"> <soap:fault name="BISecurityException"

use="literal"/> </fault>

</operation> <operation name="DestroySecurityAsset">

<soap:operation soapAction="http://

bisecurity.dsws.businessobjects.com/2006/06/

01/DestroySecurityAsset" style="document"/> <input>

<soap:body use="literal"/>

</input> <output> <soap:body use="literal"/> </output> <fault name="BISecurityException"> <soap:fault name="BISecurityException"

use="literal"/> </fault>

</operation> <operation name="CreateUser">

<soap:operation soapAction="http://

bisecurity.dsws.businessobjects.com/2006/06/

01/CreateUser" style="document"/> <input> <soap:body use="literal"/>

</input>

40 Business Process BI Services Guide

WSDL Reference

BISecurity service

</output>

</binding>

See also

BISecurity operation and messages BISecurity types BIWorkflow service

BISecurity service

The BISecurity service will group the BISecurity ports.

Example

</service>

<soap:body use="literal"/>

<fault name="BISecurityException"> <soap:fault name="BISecurityException"

use="literal"/>

</fault>

</operation>

<documentation>BISecurity Web Service</documentation>

<port name="BISecurity"

binding="s1:BISecurityBinding">

<soap:address location="http://localhost:8080/

dsws/services/bisecurity"/>

</port>

See also

BISecurity operation and messages BISecurity types BISecurity ports and binding BIWorkflow service

BISecurity namespace

The following XML namespace URI is used when the BISecurity specification is implemented: XML namespace URI:

biworkflow.dsws.businessobjects.com/2006/06/01/

http://

Business Process BI Services Guide 41

WSDL Reference

BIWorkflow service

BIWorkflow exposes the following BusinessObjects Platform services:

• Refresh documents

• Generate viewer URL

• Email, Send, Print documents

• Trigger pre-defined events

BIWorkflow WSDL - types

Simple types

Simple Types Description

CrystalReportFormat Enum

DeskiRefreshOptionsA string that represents the possible

EmailAuthentication TypeEnum

ExportModeEnum A string that represents the possible export modes for

GroupSectionsOptio nEnum

HeaderFooterOption Enum

PageLayoutEnum A string that represents the page layout options for

A string that represents the possible Crystal Reports formats. The value is constrained to constants such as PDF, RTF, WORD, and so on.

DesktopIntelligence formats. The value is constrained to constants such as DESKI, EXCEL, PDF, and so on.

A string that represents the possible email authentication methods. The value is constrained to constants such as LOGIN, PLAIN, and NONE.

various Crystal Reports formats. The value is constrained to constants such as LEGACY_MODE and STANDARD_MODE.

A string that represents the available options for group sections for various Crystal Report formats. The value is constrained to constants such as SECTIONS_EXPORT, SECTIONS_EXPORT_ISOLATED, and SECTIONS_NO_EXPORT.

A string that represents the header and footer options for Crystal Reports refreshed in Excel format. The value is constrained to constants such as NONE, ONCE, and EACH PAGE.

printing documents. The value is constrained to constants such as CUSTOM_SETTING, NO_PRINTER_SETTING, DEFAULT_PRINTER_SETTING, and so on.

42 Business Process BI Services Guide

WSDL Reference

BIWorkflow service

Simple Types Description

PageSizeEnum A string that represents the page dimensions for

printers. The value is constrained to constants such as CUSTOM, LETTER, LEGAL, and so on.

PrintCollationTypeEnumA string that represents the collation options for

printers. The value is constrained to constants such as UNCOLLATED, COLLATED, and DEFAULT.

RefreshStatusEnum A string that represents the status for documents that

have been refreshed. The value is constrained to constants such as RUNNING, COMPLETE, FAILURE, and so on.

ReportSectionsOptio nEnum

SectionTypeEnum A string that specifies the section to base the column

ServerGroupChoice Enum

WebiFormatEnum A string that represents the possible web intelligence

WebiPrecacheOutpu tTypeEnum

A string that represents the available reports sections options for various Crystal Reports format. The value is constrained to constants such as SECTIONS_EXPORT, SECTIONS_EXPORT_ISLOATED, and SECTIONS_NO_EXPORT.

width for Crystal Reports. The value is constrained to constants such as PAGE_HEADER, PAGE_FOOTER, REPORT_HEADER, and so on.

A string that represents the methods for choosing the server group with which to view a report. The value is constrained to constants such as FIRST_AVAILABLE, PREFERRED, and SPECIFIED.

formats. The value is constrained to constants such as EXCEL, PDF, and WEBI.

A string that represents the outputs types that are precached by Webi. The value is constrained to constants such as OUTPUT_HTML, OUTPUT_PDF, and OUTPUT_XLS.

Business Process BI Services Guide 43

WSDL Reference

BIWorkflow service

Complex types

Complex Types Description

CharSeparatedTextFo rmatOptions

CrystalReportFormat Options

CrystalReportRefresh Options

DBLogon Defines database logon information for Crystal

DeskiRefreshOptions Defines document refresh options for

DocumentEmailOptionsDefines options for emailing documents. The

DocumentPrinterOpti ons

DocumentRefreshOpt ions

DocumentSendOptionsDefines options for sending documents. The value

EditableRichTextForm atOptions

Defines formatting options for the characterseparated text format. The value is constrained to constants such as SameDateFormat, SameNumberFormat, Separator, and so on.

Defines formatting options for Crystal Report documents. The value is constrained to constants such as WordFormatOptions, RichTextFormatOptions, ExcelFormatOptions, and so on.

Defines document refresh options for Crystal Report documents. The value is constrained to constants such as DBLogons, FormatOptions, RecordFormula, and so on.

Reports documents. The value is constrained to constants such as ServerName, DatabaseName, UserName, and so on.

DesktopIntelligence documents. The value is constrained to constants such as PrecachePDFEnabled and PrecacheHTMLEnabled.

value is constrained to constants such as Domain, Server, Port, and so on.

Defines options for printing documents. The value is constrained to constants such as Enabled, ToPage, LandscapeMode, and so on.

Defines document refresh options. The value is constrained to constants such as Prompts, ViewingServerGroupChoice, CrystalReportRefreshOptions, and so on.

is constrained to constants such as Login, Password, and DestinationFiles.

Defines formatting options for the Editable Rich Text format. The value is constrained to constants such as AllPageExported, StartPageNumber, EndPageNumber, and so on.

44 Business Process BI Services Guide

WSDL Reference

BIWorkflow service

Complex Types Description

EmailAttachment Defines details for email attachments. The value is

constrained to constants such as EmbeddedName and MimeType.

ExcelDataOnlyFormat Options

ExcelFormatOptions Defines formatting options for the Excel Format.

PaginatedTextFormat Options

PDFFormatOptions Defines formatting options for the PDF format. The

PaginatedTextFormat Options

PlainTextFormatOptionsDefines formatting options for the Plain Text

PromptInfo Defines prompt values for documents. The value

RangePromptValue Defines range prompt values for documents. The

RefreshStatus Defines details. The value is constrained to

RangePromptValue Defines details. The value is constrained to

RichTextFormatOptionsDefines formatting options for the Rich Text

TabSeparatedFormat Options

Defines formatting options for the Excel Data-Only Format. The value is constrained to constants such as AllPageExported, StartPageNumber, ImageExported, and so on.

The value is constrained to constants such as AllPageExported, StartPageNumber, TabularFormat, and so on.

Defines formatting options for the PDF format. The value is constrained to constants such as LinesPerPage and CharactersPerInch.

value is constrained to constants such as AllPageExported, StartPageNumber, CreateBookmarksFromGroupTree, and so on.

Defines formatting options for the Paginated Text format. The value is constrained to constants such as LinesPerPage and CharactersPerInch.

format. The value is constrained to constants such as CharactersPerInch.

is constrained to constants such as DiscreteValues and RangeValues.

value is constrained to constants such as Message.

constants such as RefreshStatus and Message.

constants such as StartValue and EndValue.

format. The value is constrained to constants such as AllPageExported and StartPageNumber.

Defines formatting options for the Tab-Separated format. The value is constrained to constants such as Separator, Delimiter, ExportMode, and so on.

Business Process BI Services Guide 45

WSDL Reference

BIWorkflow service

Complex Types Description

TabSeparatedTextFor matOptions

URLHolder Contains information about a document URL. The

URLViewOptions Defines options for the generation of a document

WebiPrecacheType Includes details. The value is constrained to

WebiRefreshOptions Defines document refresh options for

WordFormatOptions Defines formatting options for the Word format.

Defines formatting options for the Tab-Separated Text format. The value is constrained to constants such as Separator, Delimiter, Exportmode, and so on.

value is constrained to constants such as DocumentID and DocumentURL.

URL. The value is constrained to constants such as IncludeAsset and RefreshOnView.

constants such as OutputType and Locale.

DesktopIntelligence documents. The value is constrained to constants such as PrecachePDFEnabled, and PrecacheHTMLEnabled.

The value is constrained to constants such as AllPageExported, StartPageNumber, and EndPageNumber.

46 Business Process BI Services Guide

WSDL Reference

BIWorkflow service

BIWorkflow WSDL - operations and messages

Operations Messages

Input Output Fault

CheckRefresh Status

EmailDocumentEmailDocumentIn EmailDocumentOut BIWorkflowExcep

FireEvents FireEventsIn FireEventsOut BIWorkflowExcep

GetDocument URL

PrintDocument PrintDocumentIn PrintDocumentOut BIWorkflowExcep

RefreshDocum ent

SendDocumentSendDocumentIn SendDocumentOut BIWorkflowExcep

CheckRefreshSta tusIn

GetDocumentUR LIn

RefreshDocumen tIn

CheckRefreshStatus Out

GetDocumentURLOutBIWorkflowExcep

RefreshDocumentOutBIWorkflowExcep

BIWorkflowExcep tion

tion

BIWorkflow types

This section describes the simple and complex types defined in the BIWorkflow WSDL document.

BIWorkflow simple types

CrystalReportFormatEnum

A string that represents possible Crystal Report formats. The value is constrained to constants such as PDF, RTF, WORD, and so on.

Example

<s:simpleType name="CrystalReportFormatEnum">

<s:restriction base="s:string"> <s:enumeration value=""/> <s:enumeration value="CRYSTAL_REPORT"/> <s:enumeration value="EXCEL"/> <s:enumeration value="EXCEL_DATA_ONLY"/> <s:enumeration value="WORD" <s:enumeration value="PDF"/> <s:enumeration value="RTF"/> <s:enumeration value="RTF_EDITABLE"/> <s:enumeration value="TEXT_PLAIN"/> <s:enumeration value="TEXT_PAGINATED"/>

Business Process BI Services Guide 47

WSDL Reference

BIWorkflow service

<s:enumeration value="TEXT_TAB_SEPARATED"/> <s:enumeration value="TEXT_CHARACTER_SEPARATED"/> <s:enumeration value="TEXT_TAB_SEPARATED_TEXT"/> </s:restriction>

</s:simpleType>

See also

CrystalReportFormatOptions CrystalReportRefreshOptions ExcelFormatOptions ExcelDataOnlyFormatOptions CrystalReportRefreshOptions

DeskiFormatEnum

A string that represents possible DesktopIntelligence formats. The value is constrained to constants such as DESKI, EXCEL, PDF, and so on.

Example

<s:simpleType name="DeskiFormatEnum">

<s:restriction base="s:string"> <s:enumeration value=""/> <s:enumeration value="DESKI"/> <s:enumeration value="EXCEL"/> <s:enumeration value="PDF"/> </s:restriction>

</s:simpleType>

See also

DeskiRefreshOptions DocumentRefreshOptions

EmailAuthenticationTypeEnum

A string that represents possible Email authentication methods. The value is constrained to constants such as LOGIN, PLAIN, and NONE.

Example

<s:simpleType name="EmailAuthenticationTypeEnum">

</s:simpleType>

Remarks

<s:restriction base="s:string"> <s:enumeration value=""/> <s:enumeration value="NONE"/> <s:enumeration value="PLAIN"/> <s:enumeration value="LOGIN"/> </s:restriction>

• NONE lets the user log on without being authenticated.

48 Business Process BI Services Guide

WSDL Reference

BIWorkflow service

• PLAIN provides authentication using a single message from the client to

the server. The message comprises the following elements in this order:

• authorization identity to login

• a US-ASCII NULL character

• the user identity

• a US-ASCII NULL character

• the clear-text password; in that order.

For example, a PLAIN Email AuthenticationType could be 'authid\0userid\0pwd'.

Note: The authorization identity can be left blank to indicate that it is the

same as the authentication identity.

See also

DocumentEmailOptions

ExportModeEnum

A string that represents possible export modes for various Crystal Report formats. The value is constrained to constants such as LEGACY_MODE and STANDARD_MODE.

Example

<s:simpleType name="ExportModeEnum">

<s:restriction base="s:string"> <s:enumeration value=""/> <s:enumeration value="LEGACY_MODE"/> <s:enumeration value="STANDARD_MODE"/> </s:restriction>

</s:simpleType>

Remarks

LEGACY_MODE supports exporting a document in the mode of an earlier product version.

See also

CharSeparatedTextFormatOptions TabSeparatedFormatOptions TabSeparatedTextFormatOptions

GroupSectionsOptionEnum

Business Process BI Services Guide 49

WSDL Reference

BIWorkflow service

Example

<s:simpleType name="GroupSectionsOptionEnum">

<s:restriction base="s:string"> <s:enumeration value=""/> <s:enumeration value="SECTIONS_EXPORT"/> <s:enumeration value="SECTIONS_EXPORT_ISOLATED"/> <s:enumeration value="SECTIONS_NO_EXPORT"/> </s:restriction>

</s:simpleType>

Remarks

• GroupSectionsOptionEnum gets the export mode.

• SECTIONS_EXPORT specifies an export sections property.

• SECTIONS_EXPORT_ISOLATED specifies an isolated export sections

property. SECTIONS_NO_EXPORT specifies a no export property to prevent exportation.

See also

CharSeparatedTextFormatOptions TabSeparatedTextFormatOptions TabSeparatedFormatOptions

HeaderFooterOptionEnum

A string that represents header and footer options for Crystal Reports refreshed into excel format. The value is constrained to constants such as NONE, ONCE, and EACH PAGE.

Example

<s:simpleType name="HeaderFooterOptionEnum">

<s:restriction base="s:string"> <s:enumeration value=""/> <s:enumeration value="NONE"/> <s:enumeration value="ONCE"/> <s:enumeration value="EACH_PAGE"/> </s:restriction>

</s:simpleType>

See also

ExcelFormatOptions

PageLayoutEnum

A string that represents page layout options for printing documents. The value is constrained to constants such as CUSTOM_SETTING, NO_PRINTER_SETTING, DEFAULT_PRINTER_SETTING, and so on.

50 Business Process BI Services Guide

WSDL Reference

BIWorkflow service

Example

<s:simpleType name="PageLayoutEnum">

<s:restriction base="s:string"> <s:enumeration value=""/> <s:enumeration value="REPORT_FILE_SETTING"/> <s:enumeration value="DEFAULT_PRINTER_SETTING"/> <s:enumeration value="NO_PRINTER_SETTING"/> <s:enumeration

value="USE_SPECIFIED_PRINTER_SETTING"/> <s:enumeration value="CUSTOM_SETTING"/> </s:restriction>

</s:simpleType>

See also

DocumentPrinterOptions

PageSizeEnum

A string that represents page dimensions for printers. The value is constrained to constants such as CUSTOM, LETTER, LEGAL, and so on.

Example

<s:simpleType name="PageSizeEnum">

<s:restriction base="s:string"> <s:enumeration value=""/> <s:enumeration value="CUSTOM"/> <s:enumeration value="LETTER"/> <s:enumeration value="LEGAL"/> <s:enumeration value="A4"/> <s:enumeration value="A5"/> <s:enumeration value="B5"/> </s:restriction>

</s:simpleType>

See also

DocumentPrinterOptions

PrintCollationTypeEnum

A string that represents collation options for printers. The value is constrained to constants such as UNCOLLATED, COLLATED, and DEFAULT.

Example

s:simpleType name="PrintCollationTypeEnum">

<s:restriction base="s:string"> <s:enumeration value=""/> <s:enumeration value="UNCOLLATED"/> <s:enumeration value="COLLATED"/> <s:enumeration value="DEFAULT"/>

Business Process BI Services Guide 51

WSDL Reference

BIWorkflow service

</s:simpleType>

See also

DocumentPrinterOptions

</s:restriction>

RefreshStatusEnum

A string that represents status for documents that have been refreshed. The value is constrained to constants such as RUNNING, COMPLETE, FAILURE, and so on.

Example

<s:simpleType name="RefreshStatusEnum">

</s:simpleType>

Remark

PENDING status refers to a state in which a process is waiting to run. A pending refresh operation means that the document has been scheduled to run at a specified time in the future.

<s:restriction base="s:string"> <s:enumeration value=""/> <s:enumeration value="RUNNING"/> <s:enumeration value="COMPLETE"/> <s:enumeration value="FAILURE"/> <s:enumeration value="PAUSED"/> <s:enumeration value="PENDING"/> <s:enumeration value="UNKNOWN"/> </s:restriction>

See also

CheckRefreshStatus

ReportSectionsOptionEnum

A string that represents available report section options for various Crystal Report formats. The value is constrained to constants such as SECTIONS_EXPORT, SECTIONS_EXPORT_ISOLATED, and SECTIONS_NO_EXPORT.

Example

<s:simpleType name="ReportSectionsOptionEnum">

</s:simpleType>

52 Business Process BI Services Guide

WSDL Reference

BIWorkflow service

Remark

SECTIONS_EXPORT specifies an export sections property.

SECTIONS_EXPORT_ISOLATED specifies an isolated export sections property. SECTIONS_NO_EXPORT specifies a no export property to prevent exportation

See also

CharSeparatedTextFormatOptions TabSeparatedFormatOptions TabSeparatedTextFormatOptions

SectionTypeEnum

Encloses collections of named integer constants. The value is constrained to constants such as PAGE_HEADER, PAGE_FOOTER, REPORT_HEADER, and so on.

Example

s:simpleType name="SectionTypeEnum">

<s:restriction base="s:string"> <s:enumeration value=""/> <s:enumeration value="REPORT_HEADER"/> <s:enumeration value="PAGE_HEADER"/> <s:enumeration value="GROUP_HEADER"/> <s:enumeration value="DETAIL"/> <s:enumeration value="GROUP_FOOTER"/> <s:enumeration value="PAGE_FOOTER"/> <s:enumeration value="REPORT_FOOTER"/> <s:enumeration value="WHOLE_REPORT"/> </s:restriction>

</s:simpleType>

See also

ExcelFormatOptions

ServerGroupChoiceEnum

A string that represents methods for choosing the server group with which to view a report. The value is constrained to constants such as FIRST_AVAILABLE, PREFERRED, and SPECIFIED.

Example

<s:simpleType name="ServerGroupChoiceEnum">

<s:restriction base="s:string"> <s:enumeration value=""/> <s:enumeration value="FIRST_AVAILABLE"/> <s:enumeration value="PREFERRED"/>

Business Process BI Services Guide 53

WSDL Reference

BIWorkflow service

<s:enumeration value="SPECIFIED"/> </s:restriction>

</s:simpleType>

Remarks

• ServerGroupChoiceEnum provides options to choose the server group

for viewing the report.

• FIRST_AVAILABLE is a constant that assigns only the server that has the

most resources free at the time of scheduling.

• PREFERRED is a constant that specifies the preferences of servers

found in the selected server group. If none of the preferred servers are available, the report is processed on the next available server.

• SPECIFIED is a constant that specifies the use of a specified server that

belongs to the selected server group. If all of these servers are unavailable, the report is not processed.

See also

DocumentRefreshOptions

WebiFormatEnum

A string that represents the possible WebIntelligence formats. The value is constrained to constants such as EXCEL, PDF, and WEBI.

Example

<s:simpleType name="WebiFormatEnum">

<s:restriction base="s:string"> <s:enumeration value=""/> <s:enumeration value="WEBI"/> <s:enumeration value="EXCEL"/> <s:enumeration value="PDF"/> </s:restriction>

</s:simpleType>

See also

WebiRefreshOptions

WebiPrecacheOutputTypeEnum

A string that represents the output types that Web pre-caches, which are as follows:

Example

<s:simpleType name="WebiPrecacheOutputTypeEnum">

54 Business Process BI Services Guide

OUTPUT_HTML,OUTPUT_PDF,and OUTPUT_XLS.

<s:restriction base="s:string"> <s:enumeration value=""/> <s:enumeration value="OUTPUT_HTML"/>

<s:enumeration value="OUTPUT_PDF"/> <s:enumeration value="OUTPUT_XLS"/> </s:restriction>

</s:simpleType>

See also

WebiPrecacheType

BIWorkflow complex types

CharSeparatedTextFormatOptions

Defines formatting options for the Character-Separated Text format. The value is constrained to constants such as SameDateFormat, SameNumberFormat, Separator, and so on.

Example

<s:complexType name="CharSeparatedTextFormatOptions">

<s:sequence> <s:element name="Separator" type="s:string"

<s:element name="Delimiter" type="s:string"

<s:element name="ExportMode"

<s:element name="GroupSectionsOption"

<s:element name="ReportSectionsOption"

<s:element name="Quote" type="s:string"

<s:element name="SameNumberFormat"

<s:element name="SameDateFormat" type="s:boolean"

</s:sequence>

</s:complexType>

Remarks

• SameDateFormat sets the date formats same as the report, and

SameNumberFormat sets the same number formats as the report.

• Separator is the character used for the “Char Separated” output.

• ExportMode is of the type STANDARD_MODE or EXPORT_MODE. For

more information, see ExportModeEnum.

WSDL Reference

BIWorkflow service

minOccurs="0"/>

type="s1:ExportModeEnum" minOccurs="0"/>

type="s1:GroupSectionsOptionEnum"

minOccurs="0"/>

type="s1:ReportSectionsOptionEnum"

minOccurs="0"/>

type="s:boolean" minOccurs="0"/>

minOccurs="0"/>

Business Process BI Services Guide 55

WSDL Reference

BIWorkflow service

• GroupSectionsOption is of the type SECTIONS_EXPORT,

SECTIONS_EXPORT_ISLOATED, or SECTIONS_NO_EXPORT. For more information about GroupSectionsOption, see

GroupSectionsOptionEnum.

See also

CrystalReportFormatOptions

Defines formatting options for Crystal Report documents. The value is constrained to constants such as WordFormatOptions, RichTextFormatOptions, ExcelFormatOptions, and so on.

Example

<s:complexType name="CrystalReportFormatOptions">

<s:sequence> <s:element name="UseExportOptionsInReport"

type="s:boolean" minOccurs="0"/>

<s:element name="Format"

type="s1:CrystalReportFormatEnum" minOccurs="0"/>

<s:element name="ExcelFormatOptions"

type="s1:ExcelFormatOptions" minOccurs="0"/>

<s:element name="ExcelDataOnlyFormatOptions"

type="s1:ExcelDataOnlyFormatOptions" minOccurs="0"/>

<s:element name="WordFormatOptions"

type="s1:WordFormatOptions" minOccurs="0"/>

<s:element name="PDFFormatOptions"

type="s1:PDFFormatOptions" minOccurs="0"/>

<s:element name="RichTextFormatOptions"

type="s1:RichTextFormatOptions" minOccurs="0"/ >

<s:element name="EditableRichTextFormatOptions"

type="s1:EditableRichTextFormatOptions" minOccurs="0"/>

<s:element name="PlainTextFormatOptions"

type="s1:PlainTextFormatOptions" minOccurs="0"/>

<s:element name="PaginatedTextFormatOptions"

type="s1:PaginatedTextFormatOptions" minOccurs="0"/>

<s:element name="CharSeparatedTextFormatOptions"

type="s1:CharSeparatedTextFormatOptions" minOccurs="0"/>

<s:element name="TabSeparatedFormatOptions"

type="s1:TabSeparatedFormatOptions" minOccurs="0"/>

56 Business Process BI Services Guide

WSDL Reference

BIWorkflow service

<s:element name="TabSeparatedTextFormatOptions"

type="s1:TabSeparatedTextFormatOptions"

minOccurs="0"/> </s:sequence>

</s:complexType>

See also

CrystalReportRefreshOptions

Defines document Refresh options for Crystal Reports Documents. The value is constrained to constants such as DBLogon, FormatOptions, RecordFormula, and so on.

Example

<s:complexType name="CrystalReportRefreshOptions">

<s:sequence> <s:element name="DBLogons" type="s1:DBLogon"

minOccurs="0" maxOccurs="unbounded"/> <s:element name="FormatOptions"

type="s1:CrystalReportFormatOptions"

minOccurs="0"/> <s:element name="RecordFormula" type="s:string"

minOccurs="0"/> <s:element name="GroupFormula" type="s:string"

minOccurs="0"/> <s:element name="ViewingServerGroupChoice"

type="s1:ServerGroupChoiceEnum" minOccurs="0"/

> <s:element name="ViewingServerGroup"

type="s:string" minOccurs="0"/> </s:sequence>

</s:complexType>

See also

DocumentRefreshOptions

Remark

Defines document Refresh options for Crystal Reports Documents. The value is constrained to constants such as DBLogon, FormatOptions, RecordFormula, and so on.

DBLogon

Defines database logon options for Crystal Reports documents. The value is constrained to constants such as ServerName, DatabaseName, UserName, and so on.

Business Process BI Services Guide 57

WSDL Reference

BIWorkflow service

Example

<s:complexType name="DBLogon">

<s:sequence> <s:element name="ServerName" type="s:string"

minOccurs="1"/>

<s:element name="DatabaseName" type="s:string"

minOccurs="1"/>

<s:element name="UserName" type="s:string"

minOccurs="1"/>

<s:element name="Password" type="s:string"

minOccurs="1"/>

</s:sequence>

</s:complexType>

See also

CrystalReportRefreshOptions

DeskiRefreshOptions

Defines document refresh options for DesktopIntelligence documents. The value is constrained to constants such as PrecacheXLSEnabled, PrecachePDFEnabled, and PrecacheHTMLEnabled.

Example

<s:complexType name="DeskiRefreshOptions">

<s:sequence> <s:element name="Format" type="s1:DeskiFormatEnum"

minOccurs="0"/>

<s:element name="PrecacheXLSEnabled"

type="s:boolean" minOccurs="0"/>

<s:element name="PrecachePDFEnabled"

type="s:boolean" minOccurs="0"/>

<s:element name="PrecacheHTMLEnabled"

type="s:boolean" minOccurs="0"/>

<s:element name="CacheServerGroupChoice"

type="s1:ServerGroupChoiceEnum" minOccurs="0"/ >

<s:element name="CacheServerGroup" type="s:string"

minOccurs="0"/>

<s:element name="ProcessingServerGroupChoice"

type="s1:ServerGroupChoiceEnum" minOccurs="0"/ >

<s:element name="ProcessingServerGroup"

type="s:string" minOccurs="0"/>

</s:sequence>

</s:complexType>

58 Business Process BI Services Guide

WSDL Reference

BIWorkflow service

Remarks

• PrecacheXLSEnabled indicates that the Microsoft excel format (XLS)

which represents a Web Intelligence document is pre-loaded into the cache. The XLS format can be cached in the Web Intelligence Report Server’s document cache when the document is scheduled or viewed.

• PrecachePDFEnabled indicates that the PDF text stream that represents

a Web Intelligence document is pre-loaded into the cache. The PDF text stream can be cached in the Web Intelligence Report Server’s document cache when the document is scheduled or viewed.

• PrecacheHTMLEnabled indicates that the HTML text stream that

represents a Web Intelligence document is pre-loaded into the cache. The HTML text stream can be cached in the Web Intelligence Report Server’s document cache when the document is scheduled or viewed.

See also

DocumentRefreshOptions

DocumentEmailOptions

Defines options for emailing documents. The value is constrained to constants such as Domain, Server, Port, and so on.

Example

<s:complexType name="DocumentEmailOptions">

<s:sequence> <s:element name="Domain" type="s:string"

minOccurs="1"/> <s:element name="Server" type="s:string"

minOccurs="1"/> <s:element name="Port" type="s:int" minOccurs="0"/

> <s:element name="Login" type="s:string"

minOccurs="1"/> <s:element name="Password" type="s:string"

minOccurs="1"/> <s:element name="AuthenticationType"

type="s1:EmailAuthenticationTypeEnum"

minOccurs="1"/> <s:element name="SenderAddress" type="s:string"

minOccurs="1"/> <s:element name="ToAddresses" type="s:string"

minOccurs="1" maxOccurs="unbounded"/> <s:element name="CcAddresses" type="s:string"

minOccurs="0" maxOccurs="unbounded"/> <s:element name="Subject" type="s:string"

minOccurs="0"/>

Business Process BI Services Guide 59

WSDL Reference

BIWorkflow service

<s:element name="Message" type="s:string"

minOccurs="0"/>

<s:element name="Delimiter" type="s:string"

minOccurs="0"/>

<s:element name="AttachmentsEnabled"

type="s:boolean" minOccurs="0"/>

<s:element name="Attachments"

type="s1:EmailAttachment" minOccurs="0" maxOccurs="unbounded"/>

</s:sequence>

</s:complexType>

Remarks

• ToAddresses and CcAddresses can be specified multiple times, once for

each address to include.

• CacheServerGroup is the name of the preferred or specified server group

with which to cache the refreshed report.

• ProcessingServerGroup is the name of the preferred or specified server

group with which to process the refreshed report.

See also

EmailDocument

DocumentPrinterOptions

Defines options for printing document. The value is constrained to constants such as Enabled, ToPage, LandscapeMode, and so on.

Example

<s:complexType name="DocumentPrinterOptions">

60 Business Process BI Services Guide

<s:sequence> <s:element name="Enabled" type="s:boolean"

minOccurs="0"/>

<s:element name="PrinterName" type="s:string"

minOccurs="0"/>

<s:element name="Copies" type="s:int"

minOccurs="0"/>

<s:element name="FromPage" type="s:int"

minOccurs="0"/>

<s:element name="ToPage" type="s:int"

minOccurs="0"/>

<s:element name="LandscapeMode" type="s:boolean"

minOccurs="0"/>

<s:element name="PageWidth" type="s:short"

minOccurs="0"/>

<s:element name="PageHeight" type="s:short"

minOccurs="0"/>

WSDL Reference

BIWorkflow service

<s:element name="PageLayout"

type="s1:PageLayoutEnum" minOccurs="0"/> <s:element name="PageSize" type="s1:PageSizeEnum"

minOccurs="0"/> <s:element name="PrintCollationType"

type="s1:PrintCollationTypeEnum"

minOccurs="0"/> </s:sequence>

</s:complexType>

See also

PrintDocument DocumentPrinterOptions

DocumentRefreshOptions

Defines Document Refresh options. The value is constrained to constants such as Prompts, ViewingServerGroupChoice, CrystalReportRefreshOptions, and so on.

Example

<s:complexType name="DocumentRefreshOptions">

<s:sequence> <s:element name="Prompts" type="s1:PromptInfo"

minOccurs="0" maxOccurs="unbounded"/> <s:element name="CrystalReportRefreshOptions"

type="s1:CrystalReportRefreshOptions"

minOccurs="0"/> <s:element name="WebiRefreshOptions"

type="s1:WebiRefreshOptions" minOccurs="0"/> <s:element name="DeskiRefreshOptions"

type="s1:DeskiRefreshOptions" minOccurs="0"/> </s:sequence>

</s:complexType>

Remarks

• Depending on the type of document being refreshed, only one of the

following must be specified in a request: CrystalReportRefreshOptions, WebiRefreshOptions, and DeskiRefreshOptions.

• Prompt values can be specified multiple times.

See also

GetDocumentURL SendDocument EmailDocument PrintDocument RefreshDocument

Business Process BI Services Guide 61

WSDL Reference

BIWorkflow service

DocumentSendOptions

Defines Document Send options. The value is constrained to constants such as Login, Password, and DestinationFiles.

Example

<s:complexType name="DocumentSendOptions">

<s:sequence> <s:element name="Login" type="s:string"

minOccurs="1"/>

<s:element name="Password" type="s:string"

minOccurs="1"/>

<s:element name="DestinationFiles" type="s:string"

minOccurs="1" maxOccurs="unbounded"/>

</s:sequence>

</s:complexType>

Remarks

• The DestinationFile is an absolute reference to the destination of the file.

That is, when the job is run, the object is sent to that destination. DestinationFile returns the DiskUnmanagedDestFiles Collection, which is used to add, delete, and modify unmanaged disk files.

• An unmanaged disk space is a location on your hard drive.

See also

SendDocument

EditableRichTextFormatOptions

Defines formatting options for the Editable Rich Text format. The value is constrained to constants such as AllPageExported, StartPageNumber, EndPageNumber, and so on.

Example

<s:complexType name="EditableRichTextFormatOptions">

</s:complexType>

62 Business Process BI Services Guide

<s:sequence> <s:element name="AllPageExported" type="s:boolean"

minOccurs="0"/>

<s:element name="StartPageNumber" type="s:int"

minOccurs="0"/>

<s:element name="EndPageNumber" type="s:int"

minOccurs="0"/>

<s:element name="PageBreakAfterEachReportPage"

type="s:boolean" minOccurs="0"/>

</s:sequence>

WSDL Reference

BIWorkflow service

See also

CrystalReportFormatOptions

EmailAttachment

Defines details for email attachments. The value is constrained to constants such as EmbeddedName and MimeType.

Example

<s:complexType name="EmailAttachment">

<s:sequence> <s:element name="EmbeddedName" type="s:string"/> <s:element name="MimeType" type="s:string"/> </s:sequence>

</s:complexType>

See also

DocumentEmailOptions

ExcelDataOnlyFormatOptions

Defines formatting options for the Excel Data-Only Format. The value is constrained to constants such as AllPageExported, StartPageNumber, ImageExported, and so on.

Example

<s:complexType name="ExcelDataOnlyFormatOptions">

<s:sequence> <s:element name="ConstColWidth" type="s:double"

minOccurs="0"/> <s:element name="ConstColWidthUsed"

type="s:boolean" minOccurs="0"/> <s:element name="PageHeaderSimplified"

type="s:boolean" minOccurs="0"/> <s:element name="ImageExported" type="s:boolean"

minOccurs="0"/> <s:element name="ColAlignmentMaintained"

type="s:boolean" minOccurs="0"/> <s:element name="PageHeaderExported"

type="s:boolean" minOccurs="0"/> <s:element name="ShowGroupOutlines"

type="s:boolean" minOccurs="0"/> <s:element name="RelativeObjPositionMaintained"

type="s:boolean" minOccurs="0"/> <s:element name="WorksheetFuncUsed"

type="s:boolean" minOccurs="0"/> <s:element name="FormatUsed" type="s:boolean"

minOccurs="0"/>

Business Process BI Services Guide 63

WSDL Reference

BIWorkflow service

<s:element name="BaseAreaType"

type="s1:SectionTypeEnum" minOccurs="0"/>

<s:element name="BaseAreaGroupNum" type="s:int"

minOccurs="0"/>

</s:sequence>

</s:complexType>

Remarks

• ImageExported specifies whether to export images.

• WorksheetFuncUsed specifies whether to use Excel worksheet functions

to represent summary fields.

• FormatUsed specifies whether to export object formats and fonts.

• BaseAreaType specifies the section the column width will be based on.

• BaseAreaGroupNum specifies the group section the column width will be

based on.

See also

CrystalReportFormatOptions

ExcelFormatOptions

Defines formatting options for the Excel Format. The value is constrained to constants such as AllPageExported, StartPageNumber, TabularFormat, and so on.

Example

<s:complexType name="ExcelFormatOptions">

<s:sequence> <s:element name="AllPageExported" type="s:boolean"

minOccurs="0"/>

<s:element name="StartPageNumber" type="s:int"

minOccurs="0"/>

<s:element name="EndPageNumber" type="s:int"

minOccurs="0"/>

<s:element name="ColumnHeadingAvailable"

type="s:boolean" minOccurs="0"/>

<s:element name="TabularFormat" type="s:boolean"

minOccurs="0"/>

<s:element name="GridlineShown" type="s:boolean"

minOccurs="0"/>

<s:element name="DateConvertedToString"

type="s:boolean" minOccurs="0"/>

<s:element name="PageHeaderExported"

type="s:boolean" minOccurs="0"/>

<s:element name="ExportPageHeaderFooter"

type="s1:HeaderFooterOptionEnum" minOccurs="0"/>

64 Business Process BI Services Guide

WSDL Reference

BIWorkflow service

<s:element name="ConstantColWidthUsed"

type="s:boolean" minOccurs="0"/> <s:element name="ConstantColWidth" type="s:double"

minOccurs="0"/> <s:element name="BaseAreaType"

type="s1:SectionTypeEnum" minOccurs="0"/> <s:element name="BaseAreaGroupNum" type="s:int"

minOccurs="0"/> <s:element name="PageBreakCreated"

type="s:boolean" minOccurs="0"/> </s:sequence>

</s:complexType>

Remarks

• ColumnHeadingAvailable specifies whether to use column headings.

• GridlineShown specifies whether to include grid lines in the export.

• BaseAreaType specifies the section the column width will be based on.

• BaseAreaGroupNum specifies the group section the column width will be

based on.

See also

CrystalReportFormatOptions

PDFFormatOptions

Defines formatting options for the PDF format. The value is constrained to constants such as AllPageExported, StartPageNumber, CreateBookmarksFromGroupTree, and so on.

Example

<s:complexType name="PDFFormatOptions">

<s:sequence> <s:element name="AllPageExported" type="s:boolean"

minOccurs="0"/> <s:element name="StartPageNumber" type="s:int"

minOccurs="0"/> <s:element name="EndPageNumber" type="s:int"

minOccurs="0"/> <s:element name="CreateBookmarksFromGroupTree"

type="s:boolean" minOccurs="0"/> </s:sequence>

</s:complexType>

See also

CrystalReportFormatOptions

Business Process BI Services Guide 65

WSDL Reference

BIWorkflow service

PaginatedTextFormatOptions

Defines formatting options for the Paginated Text format. The value is constrained to constants such as LinesPerPage and CharactersPerInch.

Example

<s:complexType name="PaginatedTextFormatOptions">

<s:sequence> <s:element name="LinesPerPage" type="s:int"

minOccurs="0"/>

<s:element name="CharactersPerInch" type="s:int"

minOccurs="0"/>

</s:sequence>

</s:complexType>

See also

CrystalReportFormatOptions PaginatedTextFormatOptions

PlainTextFormatOptions

Defines formatting options for the Plain Text format. The value is constrained to constants such as CharactersPerInch.

Example

<s:complexType name="PlainTextFormatOptions">

<s:sequence> <s:element name="CharactersPerInch" type="s:int"

minOccurs="0"/>

</s:sequence>

</s:complexType>

See also

CrystalReportFormatOptions

PromptInfo

Defines prompt values for documents. The value is constrained to constants such as DiscreteValues and RangeValues.

Example

<s:complexType name="PromptInfo">

<s:sequence> <s:element name="DiscreteValues" type="s:string"

minOccurs="0" maxOccurs="unbounded"/>

<s:element name="RangeValues"

type="s1:RangePromptValue" minOccurs="0" maxOccurs="unbounded"/>

</s:sequence>

66 Business Process BI Services Guide

WSDL Reference

BIWorkflow service

<s:attribute name="ID" type="s:string"

use="required"/>

</s:complexType>

Remarks

• PromptInfo is required only when a document is being refreshed.

• ID is the name of the prompt for which values are being set.

• Multiple DiscreteValues and RangeValues can be specified.

See also

DocumentRefreshOptions

RangePromptValue

Defines range prompt values for documents. The value is constrained to constants such as StartValue and EndValue.

Example

<s:complexType name="RangePromptValue">

<s:sequence> <s:element name="StartValue" type="s:string"

minOccurs="0" maxOccurs="1"/> <s:element name="EndValue" type="s:string"

minOccurs="0" maxOccurs="1"/> </s:sequence> <s:attribute name="StartValueInclusive"

default="true" type="s:boolean"

use="optional"/> <s:attribute name="StartValueUnbound"

default="false" type="s:boolean"

use="optional"/> <s:attribute name="EndValueInclusive"

default="true" type="s:boolean"

use="optional"/> <s:attribute name="EndValueUnbound"

default="false" type="s:boolean"

use="optional"/>

</s:complexType>

Remarks

• StartValue specifies the lower bound in the range specified.

• EndValue specifies the upper bound in the range specified.

• A true value set for StartValueInbound indicates no lower bound exists for

the StartValue; therefore, no StartValue has to be specified. A false value set for StartValueInbound indicates that you must specify a StartValue.

Business Process BI Services Guide 67

WSDL Reference

BIWorkflow service

• A true value set for EndValueInbound indicates that no upper bound

exists for the EndValue; therefore, no EndValue has to be specified. A false value set for EndValueInbound indicates that you must specify an EndValue.

See also

PromptInfo

RefreshStatus

Defines details such as RefreshStatus and Message.

Example

<s:complexType name="RefreshStatus">

<s:sequence> <s:element name="RefreshStatus"

type="s1:RefreshStatusEnum" minOccurs="1"/>

<s:element name="Message" type="s:string"

minOccurs="1"/>

</s:sequence>

</s:complexType>

Remarks

Message is a String containing the error message for a failed job.

See also

CheckRefreshStatus RefreshStatusEnum

RichTextFormatOptions

Defines formatting options for the Rich Text format. The value is constrained to constants such as AllPageExported and StartPageNumber.

Example

<s:complexType name="RichTextFormatOptions">

</s:complexType>

See also

CrystalReportFormatOptions

68 Business Process BI Services Guide

<s:sequence> <s:element name="AllPageExported" type="s:boolean"

minOccurs="0"/>

<s:element name="StartPageNumber" type="s:int"

minOccurs="0"/>

<s:element name="EndPageNumber" type="s:int"

minOccurs="0"/>

</s:sequence>

WSDL Reference

BIWorkflow service

TabSeparatedFormatOptions

Defines formatting options for the Tab-Separated format. The value is constrained to constants such as Separator, Delimiter, ExportMode, and so on.

Example

<s:complexType name="TabSeparatedFormatOptions">

<s:sequence> <s:element name="Separator" type="s:string"

minOccurs="0"/> <s:element name="Delimiter" type="s:string"

minOccurs="0"/> <s:element name="ExportMode"

type="s1:ExportModeEnum" minOccurs="0"/> <s:element name="GroupSectionsOption"

type="s1:GroupSectionsOptionEnum"

minOccurs="0"/> <s:element name="ReportSectionsOption"

type="s1:ReportSectionsOptionEnum"

minOccurs="0"/> <s:element name="SameNumberFormat"

type="s:boolean" minOccurs="0"/> <s:element name="SameDateFormat" type="s:boolean"

minOccurs="0"/> </s:sequence>

</s:complexType>

Remarks

• ExportMode exports the format of the report that is in editable rich-text

format.

• GroupSectionOption specifies an export sections property. For more

information about GroupSectionOption, see GroupSectionsOptionEnum.

See also

CrystalReportFormatOptions

TabSeparatedTextFormatOptions

Defines formatting options for the Tab-Separated Text format. The value is constrained to constants such as Separator, Delimiter, Exportmode, and so on.

Example

<s:complexType name="TabSeparatedTextFormatOptions">

<s:sequence> <s:element name="Separator" type="s:string"

minOccurs="0"/>

Business Process BI Services Guide 69

WSDL Reference

BIWorkflow service

<s:element name="Delimiter" type="s:string"

minOccurs="0"/>

<s:element name="ExportMode"

type="s1:ExportModeEnum" minOccurs="0"/>

<s:element name="GroupSectionsOption"

type="s1:GroupSectionsOptionEnum" minOccurs="0"/>

<s:element name="ReportSectionsOption"

type="s1:ReportSectionsOptionEnum" minOccurs="0"/>

</s:sequence>

</s:complexType>

See also

CrystalReportFormatOptions

URLHolder

Contains information about a document URL. The value is constrained to constants such as DocumentID and DocumentURL.

Example

<s:complexType name="URLHolder">

<s:sequence> <s:element name="DocumentID" type="s:int"

minOccurs="1"/>

<s:element name="DocumentURL" type="s:string"

minOccurs="1"/>

</s:sequence>

</s:complexType>

See also

GetDocumentURL

URLViewOptions

Defines options for the generation of a document URL. The value is constrained to constants such as IncludeAsset and RefreshOnView.

Example

<s:complexType name="URLViewOptions">

</s:complexType>

70 Business Process BI Services Guide

<s:element name="IncludeAsset" type="s:boolean"

minOccurs="0"/>

<s:element name="RefreshOnView" type="s:boolean"

minOccurs="0"/>

</s:sequence>

WSDL Reference

BIWorkflow service

Remarks

• IncludeAsset indicates that the generated URL must include appropriate

authentication information from the security asset. A user who uses the generated URL won’t have to enter logon information before viewing the document.

• RefreshOnView indicates that the generated URL will show a version of

the document with the most up-to-date information.

See also

GetDocumentURL

WebiPrecacheType

Includes details such as OutputType and Locale.

Example

<s:complexType name="WebiPrecacheType">

<s:sequence> <s:element name="OutputType"

type="s1:WebiPrecacheOutputTypeEnum"

minOccurs="0"/> <s:element name="Locales" type="s:string"

minOccurs="0" maxOccurs="unbounded"/> </s:sequence>

</s:complexType>

See also

WebiRefreshOptions

Defines document refresh options for WebIntelligence documents. The value is constrained to constants such as PrecachePDFEnabled, PrecacheXLSEnabled, and PrecacheHTMLEnabled.

Example

<s:complexType name="WebiRefreshOptions">

<s:sequence> <s:element name="Format" type="s1:WebiFormatEnum"

minOccurs="0"/> <s:element name="PrecacheXLSEnabled"

type="s:boolean" minOccurs="0"/> <s:element name="PrecacheHTMLEnabled"

type="s:boolean" minOccurs="0"/> <s:element name="PrecachePDFEnabled"

type="s:boolean" minOccurs="0"/>

Business Process BI Services Guide 71

WSDL Reference

BIWorkflow service

<s:element name="PrecacheTypes"

type="s1:WebiPrecacheType" minOccurs="0" maxOccurs="unbounded"/>

<s:element name="ViewingServerGroupChoice"

type="s1:ServerGroupChoiceEnum" minOccurs="0"/ >

<s:element name="ViewingServerGroup"

type="s:string" minOccurs="0"/>

</s:sequence>

</s:complexType>

Remark

ViewingServerGroup is the name of the preferred or specified server group with which to view the refreshed report.

See also

DeskiRefreshOptions DocumentRefreshOptions

WordFormatOptions

Defines formatting options for the Word format. The value is constrained to constants such as AllPageExported, StartPageNumber, and EndPageNumber.

Example

<s:complexType name="WordFormatOptions">

<s:sequence> <s:element name="AllPageExported" type="s:boolean"

minOccurs="0"/>

<s:element name="StartPageNumber" type="s:int"

minOccurs="0"/>

<s:element name="EndPageNumber" type="s:int"

minOccurs="0"/>

</s:sequence>

</s:complexType>

See also

CrystalReportFormatOptions

72 Business Process BI Services Guide

BIWorkflow operations and messages

GetDocumentURL

This operation constructs and returns a URL to view documents of supported types or instances of those documents. The supported types are only Crystal Reports, WebIntelligence, and DesktopIntelligence. However, OLAPIntelligence works provided no refresh options are specified.

This operation simplifies some of the options available in the open document API such as the option to view the latest instance of a document.

It also accepts a wide variety of document references including path/ document name, ID, and CUID.

Example

<fault name="BIWorkflowException" message="s1:FaultMessage"/

</operation>

<message name="GetDocumentURLOut"> <part element="s1:GetDocumentURLResponse" name="parameters"/

> </message> <s:element name="GetDocumentURL"> <s:complexType> <s:sequence> <s:element minOccurs="1" name="SecurityAsset"

type="s:string"/> <s:element minOccurs="1" name="URI" type="s:string"/> <s:element minOccurs="0" name="DocumentRefreshOptions"

type="s1:DocumentRefreshOptions"/> <s:element minOccurs="1" name="URLViewOptions"

type="s1:URLViewOptions"/> </s:sequence> </s:complexType> </s:element> <s:element name="GetDocumentURLResponse"> <s:complexType> <s:sequence> <s:element minOccurs="1" name="URLHolder"

type="s1:URLHolder"/> </s:sequence> </s:complexType> </s:element>

WSDL Reference

BIWorkflow service

Business Process BI Services Guide 73

WSDL Reference

BIWorkflow service

Message input

GetDocumentURLIn

SecurityAsset [string]

URI [string]

DocumentRefreshOptions [DocumentRefreshOptions]

URLViewOptions [URLViewOptions]

Message output

GetDocumentURLOut

URLHolder

Remarks

• The security asset must be valid.

• URI specifies the location of the document within the BusinessObjects

Enterprise system. For more information about the URI path, see the Platform Web Services Software Development Toolkit (SDK) User Guide.

• The security context must have “view” permissions to the document.

• InfoView and the openDocument API must be deployed for

GetDocumentURL to work (these tools are in desktop.war). OpenDocument API allows documents to be viewed using generated URLs.

For more information about how to grant view permissions, or how to deploy InfoView, see the BusinessObjects Enterprise Administrator’s Guide.

Note: The default format of the URL returned by GetDocumentURL() is

contained in the BusinessObjects Enterprise Central Management Server (CMS).

You can change the format of the URL: log on to the CMS, navigate to the “Objects” section, and click the “Processing Settings” tab in the “Object Settings” command button.

Also, you can override the URL specified by the CMS, by using the property opendoc.url from the BusinessProcessBI.properties file. Go to WEB-INF/ classes/BusinessProcessBI.properties. It is recommended that any URL changes that are specific to Business Process BI be performed by altering the BusinessProcessBI.properties file, instead of changing the CMS Object Settings URL property. This practise ensures other applications that connect to this CMS are not affected.

See also

BIWorkflow ports and binding

74 Business Process BI Services Guide

WSDL Reference

BIWorkflow service

Workflow specification for GetDocumentURL

Normal Scenario Workflow BPEL process sends a message to the web

service containing a security asset, a parameter specifying the document to view, and the viewing options. This process generates and returns a document viewing URL to the calling process.

Alternative Scenario Workflow None.

Error Scenario GetDocumentURL sends an error message

to the calling process under these circumstances:

• The path provided does not specify a

viewable document.

• A security asset is invalid.

• The document specified by path does

not exist in system.

• An option setting is unclassified. For

example, indicating view latest instance on instance object will result in an error condition.

• Insufficient rights have been assigned

to a document based on the current security context.

Business Rule None.

SendDocument

This operation allows the document to be sent to a specified location.

Note: SendDocument only sends objects to an unmanaged disk. An

unmanaged disk space is a location on your hard drive.

Example

</operation> name="parameters"/> </message> <message name="SendDocumentOut"> <part element="s1:SendDocumentResponse" name="parameters"/>

<input message="s1:SendDocumentIn"/> <output message="s1:SendDocumentOut"/> <fault name="BIWorkflowException"

message="s1:FaultMessage"/>

</message>

Business Process BI Services Guide 75

WSDL Reference

BIWorkflow service

<s:element name="SendDocument">

<s:complexType> <s:sequence> <s:element minOccurs="1" name="SecurityAsset"

type="s:string"/> <s:element minOccurs="1" name="URI" type="s:string"/> <s:element minOccurs="0"

name="DocumentRefreshOptions"

type="s1:DocumentRefreshOptions"/> <s:element minOccurs="1" name="DocumentSendOptions"

type="s1:DocumentSendOptions"/> </s:sequence> </s:complexType> </s:element> <s:element name="SendDocumentResponse"> <s:complexType> <s:sequence> <s:element minOccurs="1" name="ID" type="s:int"/> </s:sequence> </s:complexType>

</s:element>

Message input

SendDocumentIn

SecurityAsset [string]

URI [string]

DocumentRefreshOptions [DocumentRefreshOptions]

DocumentSendOptions [DocumentSendOptions]

Message output

SendDocumentOut

ID [int]

Remarks

• The security asset must be valid.

• URI specifies the location of the document within the BusinessObjects

Enterprise system. The document must be of a supported type for Send. For more information about the URI path, see the Platform Web Services (WS) Software Development Toolkit (SDK) User Guide.

• A file location must be valid and supported by BusinessObjects

Enterprise, and a valid document data refresh request must be sent to the service.

• A copy of the specified document is created at the specified location.

76 Business Process BI Services Guide

WSDL Reference

BIWorkflow service

See also

GetDocumentURL EmailDocument PrintDocument RefreshDocument

Workflow specification for SendDocument

Normal Scenario Workflow BPEL process sends a message to

the web service specifying the document to send, the refresh options, and target file location.

The service refreshes the specified document when appropriate, and sends a copy of the document as a file to the specified location.

Alternative Scenario Workflow None.

Error Scenario SendDocument sends an error

message to the calling process when the file location is invalid, disabled, or inaccessible.

Business Rule SendDocument and EmailDocument

are independent delivery methods and can be performed only one at a time. SendDocument sends the file to an unmanaged disk location; whereas, EmailDocument emails the document and includes the file as an attachment or as a URL.

EmailDocument

This operation allows documents to be emailed using specified SMTP options.

Example

</operation> <message name="EmailDocumentIn"> <part element="s1:EmailDocument" name="parameters"/> </message>

<input message="s1:EmailDocumentIn"/> <output message="s1:EmailDocumentOut"/> <fault name="BIWorkflowException"

message="s1:FaultMessage"/>

Business Process BI Services Guide 77

WSDL Reference

BIWorkflow service

<message name="EmailDocumentOut"> <part element="s1:EmailDocumentResponse"

name="parameters"/>

</message>

<s:element name="EmailDocument">

<s:complexType> <s:sequence> <s:element minOccurs="1" name="SecurityAsset"

type="s:string"/>

<s:element minOccurs="1" name="URI" type="s:string"/> <s:element minOccurs="0" name="DocumentRefreshOptions"

type="s1:DocumentRefreshOptions"/>

<s:element minOccurs="1" name="DocumentEmailOptions"

type="s1:DocumentEmailOptions"/>

</s:sequence> </s:complexType> </s:element> <s:element name="EmailDocumentResponse"> <s:complexType> <s:sequence> <s:element minOccurs="1" name="ID" type="s:int"/> </s:sequence> </s:complexType>

</s:element>

Message input

EmailDocumentIn

SecurityAsset [string]

URI [string]

DocumentRefreshOptions [DocumentRefreshOptions]

DocumentEmailOptions [DocumentEmailOptions]

Message output

EmailDocumentOut

ID [string]

Remarks

• The security asset for the current BusinessObjects Enterprise system

must be valid.

• URI specifies the location of the document within the BusinessObjects

Enterprise system. The document must be of a supported type for Email. For more information about the URI path, see the Platform Web Services (WS) Software Development Toolkit (SDK) User Guide.

78 Business Process BI Services Guide

WSDL Reference

BIWorkflow service

• A valid SMTP server must be configured and available to the

BusinessObjects Enterprise system, and a valid document data refresh request must be sent to the service.

• A copy of the specified document is emailed to the specified addresses.

See also

SendDocument GetDocumentURL

Workflow specification for EmailDocument

Normal Scenario Workflow BPEL process sends a message to

the web service specifying the document to email, the refresh options, and SMTP options.

An email is sent to the recipients using the mailing options specified by calling process, and a copy of the document is attached.

Alternative Scenario Workflow The service sends a newly created

document to the recipients of the email as an attachment.

Error Scenario EmailDocument sends an error

message to the calling process under these circumstances:

• An invalid SMTP configuration

exists.

• The destination of the job is

invalid, disabled, or inaccessible.

Business Rule SendDocument and EmailDocument

PrintDocument

This operation allows documents to be printed using specified Printer options.

Example

Business Process BI Services Guide 79

WSDL Reference

BIWorkflow service

<input message="s1:PrintDocumentIn"/> <output message="s1:PrintDocumentOut"/> <fault name="BIWorkflowException"

message="s1:FaultMessage"/>

</operation> <message name="PrintDocumentIn"> <part element="s1:PrintDocument"

name="parameters"/> </message> <message name="PrintDocumentOut"> <part element="s1:PrintDocumentResponse"

name="parameters"/> </message> <s:element name="PrintDocument"> <s:complexType> <s:sequence> <s:element

minOccurs="1" name="SecurityAsset" type="s:string"/> <s:element

minOccurs="1" name="URI" type="s:string"/> <s:element

minOccurs="0" name="DocumentRefreshOptions"

type="s1:DocumentRefreshOptions"/> <s:element

minOccurs="1" name="DocumentPrinterOptions"

type="s1:DocumentPrinterOptions"/> </s:sequence> </s:complexType> </s:element> <s:element name="PrintDocumentResponse"> <s:complexType> <s:sequence> <s:element

minOccurs="1" name="ID" type="s:int"/> </s:sequence> </s:complexType> </s:element>

Message input

PrintDocumentIn

SecurityAsset [string]

URI [string]

DocumentRefreshOptions [DocumentRefreshOptions]

DocumentPrinterOptions [DocumentPrinterOptions]

Message output

PrintDocumentOut

ID [int]

80 Business Process BI Services Guide

WSDL Reference

BIWorkflow service

Remarks

• The security asset must be valid.

• URI specifies the location of the document within the BusinessObjects

Enterprise system. The document must be of a supported type for Print. For more information about the URI path, see the Platform Web Services

(WS) Software Development Toolkit (SDK) User Guide.

• A valid printer must be configured and available to the BusinessObjects

Enterprise system, and a valid document data refresh request must be sent to the service.

• A copy of the specified document is printed using the specified options.

Business Process BI Services Guide 81

WSDL Reference

BIWorkflow service

Workflow specification for PrintDocument

Normal Scenario Workflow BPEL process sends a message to

the web service specifying the document to email, the refresh options, and SMTP options.

The service refreshes the document when appropriate.

A copy of the document is printed using the specified printer options.

Alternative Scenario Workflow Not applicable.

Error Scenario PrintDocument sends an error

message to the calling process under these circumstances:

• The path provided does not

specify a supported document.

• The security asset is invalid.

• The document specified by path

does not exist in the system.

• Insufficient rights have been

assigned to a document based on the current security context.

• The printer information provided

is invalid.

Business Rule If no printer information is provided,

the possible printer control option, and the default page server setting is used.

RefreshDocument

This operation creates an instance of a document with the latest available data.

Example

</operation> <message name="RefreshDocumentIn"> <part element="s1:RefreshDocument"

82 Business Process BI Services Guide

<input message="s1:RefreshDocumentIn"/> <output message="s1:RefreshDocumentOut"/><fault

name="BIWorkflowException" message="s1:FaultMessage"/>

name="parameters"/>

WSDL Reference

BIWorkflow service

</message> <message name="RefreshDocumentOut"> <part element="s1:RefreshDocumentResponse"

name="parameters"/> </message> <s:element name="RefreshDocument"> <s:complexType> <s:sequence> <s:element

minOccurs="1" name="SecurityAsset" type="s:string"/> <s:element

minOccurs="1" name="URI" type="s:string"/> <s:element

minOccurs="1" name="DocumentRefreshOptions"

type="s1:DocumentRefreshOptions"/> </s:sequence> </s:complexType> </s:element> <s:element name="RefreshDocumentResponse"> <s:complexType> <s:sequence> <s:element

minOccurs="1" name="ID" type="s:int"/> </s:sequence> </s:complexType> </s:element>

Message input

RefreshDocumentIn

SecurityAsset [string]

URI [string]

DocumentRefreshOptions [DocumentRefreshOptions]

Message output

RefreshDocumentOut

ID [int]

Remarks

• The security asset must be valid.

• URI specifies the location of the document within the BusinessObjects

Enterprise system. The document must be of a supported type for Print.

For more information about the URI path, see the Platform Web Services

(WS) Software Development Toolkit (SDK) User Guide.

• The specified document is refreshed with the latest data, and an ID

representing the new document instance is returned.

Business Process BI Services Guide 83

WSDL Reference

BIWorkflow service

See also

CheckRefreshStatus

Workflow specification for RefreshDocument

Normal Scenario Workflow BPEL process sends a message to

the web service requesting a refresh of a specific document.

The message supports the following: a. Parameters identifying the

document to view.

b. Optional refresh options such as

database login info, file output format, and parameters and prompts.

The service schedules (refreshes) the document specified using the parameters provided and generates a response message containing the ID of the newly created document instance.

84 Business Process BI Services Guide

WSDL Reference

BIWorkflow service

Alternative Scenario Workflow Not applicable.

Error Scenario RefreshDocument sends an error

message to the calling process under these circumstances:

• The path provided does not

specify a viewable or refreshable document.

• The security asset is invalid.

• The document specified by the

URI path does not exist in the system.

• Insufficient rights have been

assigned to a document based on the current security context.

• A mismatch exists in the refresh

parameters. This scenario involves possibly non-existent parameters and mismatched parameter types.

Business Rule If no optional refresh information

such as the database logon, refresh parameter, or document type is provided, the default refresh options are used.

Business Process BI Services Guide 85

WSDL Reference

BIWorkflow service

CheckRefreshStatus

This operation returns the status of a refresh operation on a specified document.

Example

<input message="s1:CheckRefreshStatusIn"/> <output message="s1:CheckRefreshStatusOut"/> <fault name="BIWorkflowException"

message="s1:FaultMessage"/>

</operation> <message name="CheckRefreshStatusIn"> <part element="s1:CheckRefreshStatus" name="parameters"/> </message> <message name="CheckRefreshStatusOut"> <part

element="s1:CheckRefreshStatusResponse"

name="parameters"/> </message> <s:element name="CheckRefreshStatus">

<s:complexType>

<s:sequence>

<s:element minOccurs="1" name="SecurityAsset"

type="s:string"/>

<s:element minOccurs="1" name="ID" type="s:int"/>

</s:sequence>

</s:complexType>

</s:element>

<s:element name="CheckRefreshStatusResponse">

<s:complexType>

<s:sequence>

<s:element minOccurs="1" name="Status"

type="s1:RefreshStatus"/>

</s:sequence>

</s:complexType> </s:element>

86 Business Process BI Services Guide

WSDL Reference

BIWorkflow service

Message input

CheckRefreshStatusIn

SecurityAsset [string]

ID [int]

Message output

CheckRefreshStatusOut

Status [RefreshStatus]

Remarks

• The security asset must be valid.

• ID is the document ID returned from operations such as

RefreshDocument, SendDocument, EmailDocument, and PrintDocument.

• CheckRefreshStatus must be called in cases where the success or failure

of a document refresh alters the path of a workflow. Call CheckRefreshStatus when more workflow operations depend on the refresh being completed.

• CheckRefreshStatus can be called repeatedly until it returns COMPLETE

or FAILURE in the RefreshStatus field.

FireEvents

See also

RefreshDocument RefreshStatusEnum GetDocumentURL

This operation ensures that events are correctly triggered.

Note: This operation is only valid for “Custom” events

Example

<input message="s1:FireEventsIn"/> <output message="s1:FireEventsOut"/> <fault name="BIWorkflowException"

message="s1:FaultMessage"/>

</operation> <message name="FireEventsIn"> <part element="s1:FireEvents"

name="parameters"/> </message> <message name="FireEventsOut">

Business Process BI Services Guide 87

WSDL Reference

BIWorkflow service

<part element="s1:FireEventsResponse"

name="parameters"/> </message> <s:element name="FireEvents"> <s:complexType> <s:sequence> <s:element

minOccurs="1" name="SecurityAsset" type="s:string"/> <s:element

minOccurs="1" name="uri" type="s:string"/> </s:sequence> </s:complexType> </s:element> <s:element name="FireEventsResponse"> <s:complexType/> </s:element>

Message input

FireEventsIn

SecurityAsset

URI

Message output

FireEventsOut

Remarks

• The security asset must be valid.

• URI specifies the location of the document within the BusinessObjects

Enterprise system. The document must be of a supported type for Print.

For more information about the URI path, see the Platform Web Services

(WS) Software Development Toolkit (SDK) User Guide.

88 Business Process BI Services Guide

Workflow specification for FireEvent

Normal Scenario Workflow BPEL process sends a message to

Alternative Scenario Workflow Not applicable.

Error Scenario FireEvent sends an error message to

Business Rule None.

BIWorkflow ports and binding

Example

<soap:binding style="document" transport="http://

schemas.xmlsoap.org/soap/http"/>

<soap:operation soapAction="http://

biworkflow.dsws.businessobjects.com/2006/06/01/ GetDocumentURL" style="document"/>

<input>

<soap:body use="literal"/> </input> <output> <soap:body use="literal"/> </output> <fault name="BIWorkflowException"> <soap:fault name="BIWorkflowException"

use="literal"/>

</fault> </operation> <operation name="SendDocument"> <soap:operation soapAction="http://

biworkflow.dsws.businessobjects.com/2006/06/01/ SendDocument" style="document"/>

<input>

<soap:body use="literal"/>

WSDL Reference

BIWorkflow service

the web service to integrate the service with events to fire.

the calling process under these circumstances:

• The current security context has

insufficient rights to add new users to BusinessObjects Enterprise.

• The events specified in the

message are not presented, or they are of an inappropriate type.

Business Process BI Services Guide 89

WSDL Reference

BIWorkflow service

</input>

90 Business Process BI Services Guide

<soap:body use="literal"/>

</output>

<soap:fault name="BIWorkflowException"

use="literal"/>

</fault> </operation>

<soap:operation soapAction="http://

biworkflow.dsws.businessobjects.com/2006/06/

01/EmailDocument" style="document"/> <input> <soap:body use="literal"/> </input> <output> <soap:body use="literal"/> </output> <fault name="BIWorkflowException"> <soap:fault name="BIWorkflowException"

use="literal"/> </fault>

</operation> <operation name="PrintDocument"> <soap:operation soapAction="http://

biworkflow.dsws.businessobjects.com/2006/06/01/ PrintDocument" style="document"/>

<input> <soap:body use="literal"/> </input> <output> <soap:body use="literal"/> </output> <fault name="BIWorkflowException"> <soap:fault name="BIWorkflowException"

use="literal"/> </fault>

</operation>

<soap:operation soapAction="http://

biworkflow.dsws.businessobjects.com/2006/06/01/ RefreshDocument" style="document"/>

WSDL Reference

BIWorkflow service

Business Process BI Services Guide 91

WSDL Reference

BIWorkflow service

<fault name="BIWorkflowException"> <soap:fault name="BIWorkflowException"

use="literal"/>

</fault>

</operation>

<soap:operation soapAction="http://

biworkflow.dsws.businessobjects.com/2006/06/

01/CheckRefreshStatus" style="document"/> <input> <soap:body use="literal"/> </input> <output> <soap:body use="literal"/> </output> <fault name="BIWorkflowException"> <soap:fault name="BIWorkflowException"

use="literal"/> </fault>

</operation>

<operation name="FireEvents"> <soap:operation soapAction="http://

biworkflow.dsws.businessobjects.com/2006/06/

01/FireEvents" style="document"/> <input> <soap:body use="literal"/> </input> <output> <soap:body use="literal"/> </output> <fault name="BIWorkflowException"> <soap:fault name="BIWorkflowException"

use="literal"/> </fault>

</operation>

</binding>

Remarks

• The BIWorkflowPort defines our web service, the operations that can be

performed, and the messages that are involved. The port defines the connection point to the web service.

• The BIWorkflowBinding defines message format and protocol details for

operations and messages defined by a particular BIWorkflowPort.

92 Business Process BI Services Guide

See also

CheckRefreshStatus RefreshDocument PrintDocument EmailDocument SendDocument GetDocumentURL FireEvents BIWorkflow service

BIWorkflow service

The BIWorkflow service groups the BIWorkflow ports.

Example

<documentation>BIWorkflow Web Service</documentation> <port name="BIWorkflow" binding="s1:BIWorkflowBinding">

<soap:address location="http://localhost:8080/dsws/

</port>

</service>

services/biworkflow"/>

WSDL Reference

BIWorkflow service

See also

BIWorkflow ports and binding

BIWorkflow namespace

The following XML namespace URI is used when the BIWorkflow specification is implemented:

targetNamespace="http://biworkflow.dsws.businessobjects.com/

2006/06/01/">

Business Process BI Services Guide 93

WSDL Reference

BIWorkflow service

94 Business Process BI Services Guide

‘

Tutorial

chapter

Tutorial

Overview

This section shows how to combine business intelligence with existing or new business processes. The tutorial will teach you how to set up a high-level web service that aligns BI services into business processes.

This tutorial assumes you are familiar with Business Process Execution Language (BPEL) tools and related web service standards such as XML Schema and WSDL.

Click the appropriate link to go to that section:

• Preconditions

• Learning Objective

• Deploying the war file

• Setting up the BISecurity service in the BPM tool

• Setting up the BIWorkflow service in the BPM tool

• Aligning your business process with the Business Process BI Services

• Enabling Clustering

• Using the Business Process BI Services Logger

Preconditions

To use the services provided by the Business Process BI Services, you will need the following:

• BusinessObjects Enterprise XI R2.

• BPEL Process Manager.

• A web application server.

• JDK 1.4.2 (or later).

• 100 MB of disk space for the BPEL Designer.

• A business process that you would like to integrate with Business

Process BI Services.

Learning Objective

In this tutorial, you learn how to integrate the GetDocumentURL and

CheckRefreshStatus feature of Business Process BI Services with your

business process.

94 Business Process BI Services Guide

This tutorial also demonstrates common tasks that are involved in accessing certain features of the Business Process BI Services Platform using your BPEL tools:

• Setting up the BISecurity service in the BPM tool

• Setting up the BIWorkflow service in the BPM tool

• Aligning your business process with the Business Process BI Services

• Enabling Clustering

• Using the Business Process BI Services Logger

At the end of the tutorial you will have set up a high-level web service that aligns your business process model with part of the BusinessObjects BI services.

Note: The step procedures in this tutorial are not specific to a particular third-

party BPEL tool. The directions for setting up may vary, depending on the BPEL tool you are using.

Deploying the war file



To verify that the war file has been deployed correctly

• In the address bar of your web browser, type the following links one at a

time:

http://localhost:8080/BusinessProcessBI/services/ bisecurity?wsdl

http://localhost:8080/BusinessProcessBI/services/ biworkflow?wsdl

Substitute your machine name for localhost, port number for 8080, and your web application server name for Business Process BI.

If the links open the respectively, the war file has been deployed correctly.

In most cases, the display of one of the WSDL files in your web browser indicates that the other file has also been correctly deployed. However, to ensure the integrity of the WAR file, it is recommended that you check that both

BISecurity and BIWorkflow WSDL files display in your web browser.

the

Note: If you are using Tomcat as your web application server, the WAR file is

deployed automatically. For all other web application servers, the WAR file must be deployed manually.

BISecurity and BIWorkflow WSDL files

Tutorial

Deploying the war file

To manually deploy the war file



1. Locate the BusinessProcessBI.war file in the following directory:

Business Process BI Services Guide 95

Tutorial

Setting up the BISecurity service in the BPM tool

\Program Files\Business Objects\BusinessObjects Enterprise 11.5\Web Services\language

Substitute the language code for

2. Copy the BusinessProcessBI.war file to your

Example:

\Program Files\Business Objects\Tomcat\webapps\

Note: For more information about deploying the BusinessProcessBI.war file

using other web application servers, see the BusinessObjects Enterprise Installation Guide.

language.

webapps directory.

Setting up the BISecurity service in the BPM tool



To set up BISecurity in the BPM tool

1. In your BPM Tool, open the asynchronous project that has your business

process workflow.

2. In your BPM tool, click the Create or Add a partnerlink button.

The Create partnerlink

3. In the Name field for the partnerlink, type

4. In the WSDL file or WSDL location field, type the following:

http://localhost:8080/BusinessProcessBI/services/ bisecurity?wsdl

Substitute your machine name for localhost, port number for 8080, and your web application server name for BusinessProcessBI.

5. Click Refresh.

The Partnerlink type and Partner role fields are auto-generated.

Note: In case the Partnerlink type and Partner role fields are not

automatically generated, click the auto-generate link to populate them. Or, in the Partnerlink type field type

Partner role field, type

6. For this tutorial, leave the MyRole field blank.

7. Click OK or Done.

page opens.

BISecurity.

BISecurityPortLink and in the

BISecurityPortProvider.

96 Business Process BI Services Guide

Setting up the BIWorkflow service in the BPM tool

Note: To check that the BISecurity file has been integrated with the BPM

tool, and to view the services that button, and then click the Explore button. This displays BISecurity operations as listed in the BISecurity WSDL - operations and messages section of the

WSDL Reference chapter.

BISecurity provides, click Overview

Setting up the BIWorkflow service in the BPM tool



To set up BIWorkflow in the BPM tool

1. In your BPM Tool, open the project that has your asynchronous business

process workflow.

2. In your BPM tool, click the Create or Add a partnerlink button.

The Create partnerlink page opens.

3. In the Name field for the partnerlink, type

4. In the WSDL file or WSDL location field, type the following:

http://localhost:8080/BusinessProcessBI/services/ biworkflow?wsdl

Substitute your machine name for localhost, port number for 8080, and your web application server name for BusinessProcessBI.

5. Click Refresh.

The Partnerlink type and Partner role fields are auto-generated.

Note: In case the Partnerlink type and Partner role fields are not

automatically generated, click the auto-generate link to populate them. Or, in the Partnerlink type field, type

Partner role field, type

6. For this tutorial, leave the MyRole field blank.

7. Click OK or Done.

Note: To check that the

tool, and to view the services that button, and then click the Explore button. This displays the BIWorkflow operations as listed in the BIWorkflow WSDL - operations and messages section in the WSDL Reference chapter.

BISecurityPortProvider.

BIWorkflow file has been integrated with the BPM

BIWorkflow provides, click Overview

BIWorkflow.

BISecurityPortLink. Then, in the

Tutorial

Business Process BI Services Guide 97

Tutorial

Aligning your business process with the Business Process BI Services

In this section, you will learn how to integrate the Business Process BI Services that provides a secure user logon, gets the URL of an object whose path has been specified, and checks the refresh status of the document.

This process involves the following tasks:

• Adding a CreateSecurityAsset invoke activity.

• Adding a PopulateSecurityInfo assign activity.

• Adding a scope activity.

• Adding a ConsumeAsset assign activity.

• Adding a GetDocumentURL invoke activity.

• Adding a GetID assign activity.

• Adding a CheckRefreshStatus invoke activity.

To add a CreateSecurityAsset invoke activity



Note: This procedure is required for the integration of any business

process model with the Business Process BI Services.

1. In your BPEL tool, open the business process model that you would like

to integrate with the Business Process BI Services with, and click

Process Map to see your workflow.

2. From the Component Palette or BPEL Palette, drag an invoke activity

to your project, between the <initiate> and <onresult> activity, where you would like to insert the services provided by Business Process BI Services.

Place the invoke activity at the point in your business process model where you would like the services of Business Process BI Services to start and end.

3. On the BPEL Inspector or Properties Inspector pane, do the following:

a. In the process name field, type

b. In the partnerLink field, select BISecurity

c. In the operation field, select CreateSecurityAsset.

d. In the inputVariable field, select Create Global variable.

The New Variable Wizard page opens.

e. In the Variable name field, type

lick Done or OK.

CreateSecurityAsset.

CreateSecurityAssetInput.

98 Business Process BI Services Guide

Business objects PRINTFORM 7.90C User Manual

Specifications and Main Features

Frequently Asked Questions

User Manual

Contents

Start Here

Overview of Business Process BI Services

What are Web Services?

Web Service Description Language (WSDL)

How do web services work?

How are web services used in a Business Process Management Environment?

The extranet effect

The next step: the web service

Going further: collaboration

Introduction to Business Process BI Services

The services provided by the Business Process BI Services

Setting up Business Process BI Services

WSDL Reference

WSDL

Definition

WSDL document example

WSDL document structure

types

operations and messages

portType

binding

services

BISecurity service

About namespaces

Business Process BI Services and the WSDL document

BISecurity types

BISecurity simple types

BISecurity complex types

BISecurity operation and messages

BISecurity ports and binding

BISecurity port

BISecurity bindings

BISecurity service

BISecurity namespace

BIWorkflow service

BIWorkflow types

BIWorkflow simple types

BIWorkflow complex types

BIWorkflow operations and messages

GetDocumentURL

SendDocument

EmailDocument

PrintDocument

RefreshDocument

CheckRefreshStatus

FireEvents

BIWorkflow ports and binding

BIWorkflow service

BIWorkflow namespace

Tutorial

Preconditions

Learning Objective

Deploying the war file

Setting up the BISecurity service in the BPM tool

Setting up the BIWorkflow service in the BPM tool

Aligning your business process with the Business Process BI Services