Escolar Documentos
Profissional Documentos
Cultura Documentos
Copyright
2010 SAP AG. All rights reserved.SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP Business ByDesign, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and other countries. Business Objects and the Business Objects logo, BusinessObjects, Crystal Reports, Crystal Decisions, Web Intelligence, Xcelsius, and other Business Objects products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Business Objects S.A. in the United States and in other countries. Business Objects is an SAP company.All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty. 2010-05-30
Contents
Chapter 1 Start here 7 Chapter 2 Overview of Business Process BI Services 9
What are Web Services? ..........................................................................10 How do web services work? .....................................................................11 How are web services used in a Business Process Management Environment? ......................................................................................12 Introduction to Business Process BI Services ..........................................14 The services provided by the Business Process BI Services .............15 Chapter 3 WSDL reference 21
WSDL .......................................................................................................22 WSDL document structure ..................................................................23 About namespaces ..............................................................................28 Business Process BI Services and the WSDL document ...................28 BISecurity service .....................................................................................29 BISecurity simple types .......................................................................31 BISecurity complex types ....................................................................31 BISecurity operation and messages ...................................................36 BISecurity ports and binding ...............................................................43 BISecurity service ................................................................................45 BISecurity namespace ........................................................................45 BIWorkflow service ...................................................................................46 BIWorkflow simple types .....................................................................55 BIWorkflow complex types ..................................................................65 BIWorkflow operations and messages ................................................86
Contents
BIWorkflow ports and binding ............................................................105 BIWorkflow service ............................................................................107 BIWorkflow namespace .....................................................................108 Chapter 4 Tutorial 109
Preconditions ..........................................................................................110 Learning objective ...................................................................................110 Deploying the WAR file ...........................................................................111 To verify that the war file has been deployed correctly......................111 To manually deploy the WAR file........................................................111 Security considerations while working with your web application server.................................................................................................112 Setting up the BISecurity service in the BPM tool ..................................112 To set up BISecurity in the BPM tool..................................................112 Setting up the BIWorkflow service in the BPM tool .................................113 To set up BIWorkflow in the BPM tool................................................113 To add a scope activity............................................................................114 To add a CreateSecurityAsset invoke activity....................................114 To add a PopulateSecurityInfo assign activity....................................115 To add a scope activity.......................................................................117 To add a GetDocumentURL invoke activity........................................117 To add a GetDocumentURL invoke activity........................................118 To add a ConsumeAsset assign activity.............................................118 To add a CheckRefreshStatus invoke activity....................................123 Enabling Clustering .................................................................................123 To enable clustering ..........................................................................124 Using the Business Process BI Services Logger ..............................124 To locate a log file...............................................................................124 To change the log file location............................................................125 To set the system properties for the Business Process BI Services logger.................................................................................................125
Contents
To use a predefined logging level.......................................................125 To create your own logging level........................................................126 Chapter 5 Get More Help 127
Appendix A
More Information
131
Contents
Start here
Start here
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.
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 re-factor 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.
10
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
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.
11
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.
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.
12
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. The diagram below illustrates a typical web services deployment.
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.
13
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 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 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.
15
Note:
The lifespan of asset in minutes. The number of allowed logons for a given asset.
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.
16
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:
17
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.
18
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 pre-defined 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.
19
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 .
20
WSDL reference
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.
WSDL
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://ex ample.com/stockquote.wsdl" xmlns:tns="http://exam ple.com/stockquote.wsdl" xmlns:xsd1="http://exam ple.com/stockquote.xsd" xmlns:soap="http://schemas.xml soap.org/wsdl/soap/" xmlns="http://schemas.xmlsoap.org/ws dl/"> <types> <schema targetNamespace="http://example.com/stock quote.xsd" xmlns="http://www.w3.org/2000/10/XMLSchema"> <element name="PriceRequest"> <complexType> <all> <element name="tickerSymbol" type="string"/> </all> </complexType> </element> <element name="Price"> <complexType> <all> <element name="price" type="float"/> </all> </complexType> </element> </schema> </types> <message name="GetLastPriceInput"> <part name="body" element="xsd1:PriceRequest"/>
22
</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:Stock QuotePortType"> <soap:binding style="document" trans port="http://schemas.xmlsoap.org/soap/http"/> <operation name="GetLastPrice"> <soap:operation soapAction="http://exam ple.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:Stock QuoteBinding"> <soap:address location="http://exam ple.com/stockquote"/> </port> </service> </definitions>
23
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.
types
The types element contains data definitions that the exchanged messages use.
Syntax
A WSDL Schema contains types that are either simple or complex. <definitions .... > <types> <xsd:schema .... /> </types> </definitions>
Example: Simple types
Simple types cannot have attributes or child elements between the opening and closing tags of the element. <s:simpleType name="HeaderFooterOptionEnum"> <s:restriction base="s:string">
24
<s:enumeration value="NONE" /> <s:enumeration value="ONCE" /> <s:enumeration value="EACH_PAGE" /> </s:restriction> </s:simpleType>
Syntax
A WSDL Schema contains types that are either simple or complex. <definitions .... > <types> <xsd:schema .... /> </types> </definitions>
Example: Simple types
Simple types cannot have attributes or child elements between the opening and closing tags of the element. <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>
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:
25
minOccurs="1"/> <s:element name="AccountName" type="s:string" minOc curs="1"/> <s:element name="Password" type="s:string" minOc curs="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" minOc curs="0"/> </s:sequence> </s:complexType>
<definitions .... > <message name="nmtoken"> <part name="nmtoken" element="qname"? type="qname"?/> </message> </definitions> 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.
26
portType
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.
binding
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>
27
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> </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.
28
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
A string that represents the licensing scheme of users, the value of which is constrained to be either NAMED or CONCURRENT.
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.
29
Complex Types
Description
UserInfo
Defines options for user creation. The value is constrained to constants such as AccountName, Password, UserType, and so on. Defines constraints on password. The value is constrained to constants such as PasswordNeverExpires, MustChangePassword, and CannotChangePassword.
UserSecuritySettings
BISecurity opera CreateSecurityAs CreateSecurityAs BISecurityExcep tion and mes setIn setOut tion sages BISecurityExcep tion BISecurityExcep tion
CreateUser
CreateUserIn
CreateUserOut
DestroySecu rityAsset
DestroySecu rityAssetIn
DestroySecu rityAssetOut
30
A string that represents the licensing scheme of users, the value of which is constrained to be either NAMED or CONCURRENT.
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>
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" minOccurs="1"/> <s:element name="AssetDuration" type="s:int" minOc curs="0"/> <s:element name="MaxLoginCount" type="s:int" minOc curs="0"/> </s:sequence> </s:complexType>
31
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. AssetDuration represents the duration in minutes for which an asset is valid.
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" minOc curs="1"/> <s:element name="Password" type="s:string" minOc curs="0"/> <s:element name="Domain" type="s:string" minOc curs="0"/> <s:element name="Locale" type="s:string" minOc curs="0"/> <s:element name="TimeZone" type="s:string" minOc curs="0"/> <s:element name="SharedSecret" type="s:string"
32
minOccurs="0"/> <s:element name='ReportedIPAddress' type='s:string' minOccurs="0"/> <s:element name='ReportedHostName' 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 SAP BusinessObjects Enterprise Administrator's Guide. 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_YYSubstitute 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
33
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 SAP BusinessObjects Enterprise Administrator's 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 SAP BusinessObjects Enterprise Administrator's Guide. Business Objects Web services require the consumer to report IP address and machine name of the machine it is running on.This information needs to be sent to web services provider and is known as ReportedIPAddress and ReportedMachineName. ReportedIPAddress and ReportedMachineName enable IP auditing the database in web services. ReportedIPAddress is the internet protocol of the machine where the Import Wizard runs. ReportedIPAddress is set by the user. ReportedHostName Address of machine a machine is the machine name on which SDK is installed and is determined and filled in by the SDK.
Related Topics
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> <s:element name="AccountName" type="s:string" minOc curs="1"/> <s:element name="Password" type="s:string" minOc curs="1"/> <s:element name="UserType" type="s1:UserTypeEnum" minOccurs="1"/> <s:element name="FullName" type="s:string" minOc curs="0"/>
34
<s:element name="EmailAddress" type="s:string" minOccurs="0"/> <s:element name="Description" type="s:string" minOc curs="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.
Related Topics
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:sequence> <s:element name="PasswordNeverExpires" type="s:boolean" minOccurs="0"/> <s:element name="MustChangePassword" type="s:boolean" minOccurs="0"/> <s:element name="CannotChangePassword" type="s:boolean" minOccurs="0"/> </s:sequence> </s:complexType>
35
Related Topics
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
<operation name="CreateSecurityAsset"> <input message="s1:CreateSecurityAssetIn"/> <output message="s1:CreateSecurityAssetOut"/> <fault name="BISecurityException" message="s1:FaultMes sage"/> </operation> <message name="CreateSecurityAssetIn"> <part element="s1:CreateSecurityAsset" name="parame ters"/> </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"
36
type="s1:LogonInfo" /> <s:element minOccurs="0" name="AssetLifespanOp tions" type="s1:AssetLifespanOptions" /> </s:sequence> </s:complexType> </s:element> <s:element name="CreateSecurityAssetResponse"> <s:complexType> <s:sequence> <s:element name="SecurityAsset" type="s:string" /> </s:sequence> </s:complexType> </s:element>
Message input
CreateSecurityAssetOut SecurityAsset[string]
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.
37
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 asset duration in minutes, ValidForHosts, and valid number of logons. The service authenticates the user using the authentication information. Partial authentication information is provided. Alternative Scenario Workflow The service authenticates using default settings that are contained in a configuration file. Authentication may fail due to invalid information or non-existent account. Error Scenario The BusinessObjects Enterprise exception is formatted to a suitable SOAP exception response message. The security asset represents the authenticated user and acts as a ticket for retrieving one or more BusinessObjects Enterprise sessions.
Business Rule
38
Related Topics
UserSecuritySettings
CreateUser
This operation adds a new BusinessObjects Enterprise user from within a BPEL process.
Example
<operation name="CreateUser"> <input message="s1:CreateUserIn"/> <output message="s1:CreateUserOut"/> <fault name="BISecurityException" message="s1:FaultMes sage"/> </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
39
Message output
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 SAP BusinessObjects Enterprise Administrator's Guide.
Workflow Specification for CreateUser
BPEL process sends a message to the web service with valid user parameters. Normal Scenario Workflow The service then adds the user to the BusinessObjects Enterprise system with the specified options and attributes. Not applicable.
40
CreateUser returns an error message to the calling process under these circumstances: The current security context has insufficient rights to add new users to BusinessObjects Enterprise. Error Scenario
The user groups specified are invalid. The password specified does not meet the security criteria required by a security plug-in. A duplicate account name exists.
Business Rule
None.
Related Topics
LogonInfo
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
<operation name="DestroySecurityAsset"> <input message="s1:DestroySecurityAssetIn"/> <output message="s1:DestroySecurityAssetOut"/> <fault name="BISecurityException" message="s1:FaultMes sage"/> </operation> <message name="DestroySecurityAssetIn">
41
<part element="s1:DestroySecurityAsset" name="parame ters"/> </message> <message name="DestroySecurityAssetOut"> <part element="s1:DestroySecurityAssetResponse" name="parameters"/> </message> <s:element name="DestroySecurityAsset"> <s:complexType> <s:sequence> </s:sequence> </s:complexType> </s:element> <s:element name="DestroySecurityAssetResponse"> <s:complexType> <s:sequence/> </s:complexType> </s:element>
Message input
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.
42
BPEL process sends a message to the web service containing the security asset to be invalidated. Normal Scenario Workflow 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. Not applicable. Invalidation or destruction of a security asset has no affect on an open BusinessObjects Enterprise Session.
Error Scenario
Business Rule
Related Topics
UserSecuritySettings
43
BISecurity bindings
The BISecurityBinding defines the message format and protocol details for operations and messages defined by the BISecurityPort.
Example
<binding name="BISecurityBinding" type="s1:BISecurity Port"> <soap:binding style="document" trans port="http://schemas.xmlsoap.org/soap/http"/> <operation name="CreateSecurityAsset"> <soap:operation soapAction="http://bisecurity.dsws.busi nessobjects.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="liter al"/> </fault> </operation> <operation name="DestroySecurityAsset"> <soap:operation soapAction="http://bisecurity.dsws.busi nessobjects.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="liter al"/> </fault> </operation> <operation name="CreateUser"> <soap:operation soapAction="http://bisecurity.dsws.busi
44
nessobjects.com/2006/06/01/CreateUser" style="document"/> <input><soap:body use="literal"/></input> <output> <soap:body use="literal"/> </output> <fault name="BISecurityException"> <soap:fault name="BISecurityException" use="liter al"/> </fault> </operation>
Related Topics
BIWorkflow service
BISecurity service
The BISecurity service will group the BISecurity ports.
Example
<service name="BISecurity"> <documentation>BISecurity Web Service</documentation> <port name="BISecurity" binding="s1:BISecurityBinding"> <soap:address location="http://local host:8080/dsws/services/bisecurity"/> </port> </service>
Related Topics
BIWorkflow service
BISecurity namespace
The following XML namespace URI is used when the BISecurity specification is implemented: XML namespace URI: http://biworkflow.dsws.busi nessobjects.com/2006/06/01/
45
BIWorkflow service
BIWorkflow exposes the following BusinessObjects Platform services: Refresh documents Generate viewer URL Email, Send, Print documents Trigger pre-defined events
CrystalReportFormatEnum
A string that represents the possible Crystal Reports formats. The value is constrained to constants such as PDF, RTF, WORD, and so on. A string that represents the possible 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.
DeskiRefreshOptions
EmailAuthenticationTypeEnum
46
Simple Types
Description
ExportModeEnum
A string that represents the possible export modes for 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. A string that represents the 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. A string that represents the page dimensions for printers. The value is constrained to constants such as CUSTOM, LETTER, LEGAL, and so on.
GroupSectionsOptionEnum
HeaderFooterOptionEnum
PageLayoutEnum
PageSizeEnum
47
Simple Types
Description
PrintCollationTypeEnum
A string that represents the collation options for printers. The value is constrained to constants such as UNCOLLATED, COLLATED, and DEFAULT. 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. 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. A string that specifies the section to base the column 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.
RefreshStatusEnum
ReportSectionsOptionEnum
SectionTypeEnum
ServerGroupChoiceEnum
48
Simple Types
Description
WebiFormatEnum
A string that represents the possible web intelligence 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.
WebiPrecacheOutputTypeEnum
Complex types
Complex Types
Description
Defines formatting options for the character-separated 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.
CrystalReportFormatOptions
49
Complex Types
Description
CrystalReportRefreshOptions
Defines document refresh options for Crystal Report documents. The value is constrained to constants such as DBLogons, FormatOptions, RecordFormula, and so on. Defines database logon information for Crystal Reports documents. The value is constrained to constants such as ServerName, DatabaseName, UserName, and so on. Defines document refresh options for DesktopIntelligence documents. The value is constrained to constants such as PrecachePDFEnabled and PrecacheHTMLEnabled. Defines options for emailing documents. The 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.
DBLogon
DeskiRefreshOptions
DocumentEmailOptions
DocumentPrinterOptions
DocumentRefreshOptions
50
Complex Types
Description
DocumentSendOptions
Defines options for sending documents. The value 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. Defines details for email attachments. The value is constrained to constants such as EmbeddedName and MimeType. Defines formatting options for the Excel Data-Only Format. The value is constrained to constants such as AllPageExported, StartPageNumber, ImageExported, and so on. Defines formatting options for the Excel Format. 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.
EditableRichTextFormatOptions
EmailAttachment
ExcelDataOnlyFormatOptions
ExcelFormatOptions
PaginatedTextFormatOptions
51
Complex Types
Description
PDFFormatOptions
Defines formatting options for the PDF format. The 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. Defines formatting options for the Plain Text format. The value is constrained to constants such as CharactersPerInch. Defines prompt values for documents. The value is constrained to constants such as DiscreteValues and RangeValues. Defines range prompt values for documents. The value is constrained to constants such as Message. Defines details. The value is constrained to constants such as RefreshStatus and Message.
PaginatedTextFormatOptions
PlainTextFormatOptions
PromptInfo
RangePromptValue
RefreshStatus
52
Complex Types
Description
RangePromptValue
Defines details. The value is constrained to constants such as StartValue and EndValue. Defines formatting options for the Rich Text 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. Defines formatting options for the Tab-Separated Text format. The value is constrained to constants such as Separator, Delimiter, Exportmode, and so on. Contains information about a document URL. The value is constrained to constants such as DocumentID and DocumentURL. Defines options for the generation of a document URL. The value is constrained to constants such as IncludeAsset and RefreshOnView.
RichTextFormatOptions
TabSeparatedFormatOptions
TabSeparatedTextFormatOptions
URLHolder
URLViewOptions
53
Complex Types
Description
WebiPrecacheType
Includes details. The value is constrained to constants such as OutputType and Locale. Defines document refresh options for DesktopIntelligence documents. The value is constrained to constants such as PrecachePDFEnabled, and PrecacheHTMLEnabled. Defines formatting options for the Word format. The value is constrained to constants such as AllPageExported, StartPageNumber, and EndPageNumber.
WebiRefreshOptions
WordFormatOptions
CheckRefreshSta CheckRefreshSta CheckRefreshSta BIWorkflowExcep tusIn tusOut tion tus EmailDocu mentOut BIWorkflowExcep tion
EmailDocument
EmailDocumentIn
54
FireEvents
FireEventsIn
FireEventsOut
BIWorkflowExcep tion
PrintDocument
PrintDocumentIn
RefreshDocu ment
RefreshDocu mentIn
SendDocument
SendDocumentIn
A string that represents possible Crystal Report formats. The value is constrained to constants such as PDF, RTF, WORD, and so on.
Example
55
<s:enumeration <s:enumeration <s:enumeration <s:enumeration <s:enumeration <s:enumeration <s:enumeration <s:enumeration <s:enumeration <s:enumeration <s:enumeration <s:enumeration </s:restriction> </s:simpleType>
Related Topics
value="CRYSTAL_REPORT"/> value="EXCEL"/> value="EXCEL_DATA_ONLY"/> value="WORD" value="PDF"/> value="RTF"/> value="RTF_EDITABLE"/> value="TEXT_PLAIN"/> value="TEXT_PAGINATED"/> value="TEXT_TAB_SEPARATED"/> value="TEXT_CHARACTER_SEPARATED"/> value="TEXT_TAB_SEPARATED_TEXT"/>
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>
Related Topics
DocumentRefreshOptions
EmailAuthenticationTypeEnum
A string that represents possible Email authentication methods. The value is constrained to constants such as LOGIN, PLAIN, and NONE.
56
Example
<s:simpleType name="EmailAuthenticationTypeEnum"> <s:restriction base="s:string"> <s:enumeration value=""/> <s:enumeration value="NONE"/> <s:enumeration value="PLAIN"/> <s:enumeration value="LOGIN"/> </s:restriction> </s:simpleType>
Remarks
NONE lets the user log on without being authenticated. 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.
The authorization identity can be left blank to indicate that it is the same as the authentication identity.
Related Topics
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.
57
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
TabSeparatedFormatOptions
GroupSectionsOptionEnum
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.
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.
58
SECTIONS_EXPORT_ISOLATED specifies an isolated export sections property. SECTIONS_NO_EXPORT specifies a no export property to prevent exportation.
Related Topics
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>
Related Topics
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.
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"/>
59
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>
Related Topics
DocumentPrinterOptions
PrintCollationTypeEnum
A string that represents collation options for printers. The value is constrained to constants such as UNCOLLATED, COLLATED, and DEFAULT.
Example
60
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"/> </s:restriction> </s:simpleType>
Related Topics
DocumentPrinterOptions
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
61
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
Related Topics
TabSeparatedFormatOptions
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>
Related Topics
ExcelFormatOptions
62
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"/> <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.
Related Topics
DocumentRefreshOptions
WebiFormatEnum
A string that represents the possible WebIntelligence formats. The value is constrained to constants such as EXCEL, PDF, and WEBI.
63
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>
Related Topics
WebiRefreshOptions
WebiPrecacheOutputTypeEnum
A string that represents the output types that Web pre-caches, which are as follows: OUTPUT_HTML,OUTPUT_PDF,and OUTPUT_XLS
Example
<s:simpleType name="WebiPrecacheOutputTypeEnum"> <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>
Related Topics
WebiPrecacheType
64
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" minOc curs="0"/> <s:element name="Delimiter" type="s:string" minOc curs="0"/> <s:element name="ExportMode" type="s1:ExportModeEnum" minOccurs="0"/> <s:element name="GroupSectionsOption" type="s1:Group SectionsOptionEnum" minOccurs="0"/> <s:element name="ReportSectionsOption" type="s1:Report SectionsOptionEnum" minOccurs="0"/> <s:element name="Quote" type="s:string" 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
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 . GroupSectionsOption is of the type SECTIONS_EXPORT, SECTIONS_EXPORT_ISLOATED, or SECTIONS_NO_EXPORT. For
65
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:CrystalReportFor matEnum" minOccurs="0"/> <s:element name="ExcelFormatOptions" type="s1:Ex celFormatOptions" minOccurs="0"/> <s:element name="ExcelDataOnlyFormatOptions" type="s1:ExcelDataOnlyFormatOptions" minOccurs="0"/> <s:element name="WordFormatOptions" type="s1:WordFor matOptions" minOccurs="0"/> <s:element name="PDFFormatOptions" type="s1:PDFFor matOptions" 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"/> <s:element name="TabSeparatedTextFormatOptions" type="s1:TabSeparatedTextFormatOptions" minOccurs="0"/> </s:sequence> </s:complexType>
Related Topics
CrystalReportRefreshOptions
66
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" minOc curs="0" maxOccurs="unbounded"/> <s:element name="FormatOptions" type="s1:CrystalReport FormatOptions" minOccurs="0"/> <s:element name="RecordFormula" type="s:string" minOc curs="0"/> <s:element name="GroupFormula" type="s:string" minOc curs="0"/> <s:element name="ViewingServerGroupChoice" type="s1:ServerGroupChoiceEnum" minOccurs="0"/> <s:element name="ViewingServerGroup" type="s:string" minOccurs="0"/> </s:sequence> </s:complexType>
Remark
Defines document Refresh options for Crystal Reports Documents. The value is constrained to constants such as DBLogon, FormatOptions, RecordFormula, and so on.
Related Topics
DocumentRefreshOptions
DBLogon
Defines database logon options for Crystal Reports documents. The value is constrained to constants such as ServerName, DatabaseName, UserName, and so on.
67
Example
<s:complexType name="DBLogon"> <s:sequence> <s:element name="ServerName" type="s:string" minOc curs="1"/> <s:element name="DatabaseName" type="s:string" minOc curs="1"/> <s:element name="UserName" type="s:string" minOc curs="1"/> <s:element name="Password" type="s:string" minOc curs="1"/> </s:sequence> </s:complexType>
Remark
The DBLogon fields ServerName and DatabaseName are used only to indicate the data source for which the workflow will set the UserName and Password fields. ServerName and DatabaseName are not meant to be used to set server and database values when refreshing the report. If a workflow specifies ServerName and DatabaseName values that do not exist in the report object, DBLogon is ignored and a warning is logged on the web server.
Related Topics
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"/>
68
<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>
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.
Related Topics
DocumentRefreshOptions
DocumentEmailOptions
Defines options for emailing documents. The value is constrained to constants such as Domain, Server, Port, and so on.
Example
69
curs="1"/> <s:element name="Server" type="s:string" minOc curs="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" minOc curs="1"/> <s:element name="AuthenticationType" type="s1:EmailAu thenticationTypeEnum" minOccurs="1"/> <s:element name="SenderAddress" type="s:string" minOc curs="1"/> <s:element name="ToAddresses" type="s:string" minOc curs="1" maxOccurs="unbounded"/> <s:element name="CcAddresses" type="s:string" minOc curs="0" maxOccurs="unbounded"/> <s:element name="Subject" type="s:string" minOc curs="0"/> <s:element name="Message" type="s:string" minOc curs="0"/> <s:element name="Delimiter" type="s:string" minOc curs="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.
Related Topics
EmailDocument
70
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"> <s:sequence> <s:element name="Enabled" type="s:boolean" minOc curs="0"/> <s:element name="PrinterName" type="s:string" minOc curs="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" minOc curs="0"/> <s:element name="PageHeight" type="s:short" minOc curs="0"/> <s:element name="PageLayout" type="s1:PageLayoutEnum" minOccurs="0"/> <s:element name="PageSize" type="s1:PageSizeEnum" minOccurs="0"/> <s:element name="PrintCollationType" type="s1:PrintCol lationTypeEnum" minOccurs="0"/> </s:sequence> </s:complexType>
Related Topics
DocumentPrinterOptions
DocumentRefreshOptions
Defines Document Refresh options. The value is constrained to constants such as Prompts, ViewingServerGroupChoice, CrystalReportRefreshOptions, and so on.
71
Example
<s:complexType name="DocumentRefreshOptions"> <s:sequence> <s:element name="Prompts" type="s1:PromptInfo" minOc curs="0" maxOccurs="unbounded"/> <s:element name="CrystalReportRefreshOptions" type="s1:CrystalReportRefreshOptions" minOccurs="0"/> <s:element name="WebiRefreshOptions" type="s1:WebiRe freshOptions" 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.
Related Topics
RefreshDocument
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" minOc curs="1"/> <s:element name="DestinationFiles" type="s:string" minOccurs="1" maxOccurs="unbounded"/> </s:sequence> </s:complexType>
72
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.
Related Topics
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:sequence> <s:element name="AllPageExported" type="s:boolean" minOccurs="0"/> <s:element name="StartPageNumber" type="s:int" minOc curs="0"/> <s:element name="EndPageNumber" type="s:int" minOc curs="0"/> <s:element name="PageBreakAfterEachReportPage" type="s:boolean" minOccurs="0"/> </s:sequence> </s:complexType>
Related Topics
CrystalReportFormatOptions
EmailAttachment
Defines details for email attachments. The value is constrained to constants such as EmbeddedName and MimeType.
73
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>
Related Topics
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" minOc curs="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" minOc curs="0"/> <s:element name="BaseAreaType" type="s1:SectionType Enum" minOccurs="0"/>
74
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.
Related Topics
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" minOc curs="0"/> <s:element name="EndPageNumber" type="s:int" minOc curs="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"
75
type="s:boolean" minOccurs="0"/> <s:element name="PageHeaderExported" type="s:boolean" minOccurs="0"/> <s:element name="ExportPageHeaderFooter" type="s1:HeaderFooterOptionEnum" minOccurs="0"/> <s:element name="ConstantColWidthUsed" type="s:boolean" minOccurs="0"/> <s:element name="ConstantColWidth" type="s:double" minOccurs="0"/> <s:element name="BaseAreaType" type="s1:SectionType Enum" minOccurs="0"/> <s:element name="BaseAreaGroupNum" type="s:int" minOc curs="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.
Related Topics
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" minOc
76
curs="0"/> <s:element name="EndPageNumber" type="s:int" minOc curs="0"/> <s:element name="CreateBookmarksFromGroupTree" type="s:boolean" minOccurs="0"/> </s:sequence> </s:complexType>
Related Topics
CrystalReportFormatOptions
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" minOc curs="0"/> <s:element name="CharactersPerInch" type="s:int" minOccurs="0"/> </s:sequence> </s:complexType>
Related Topics
PaginatedTextFormatOptions
PlainTextFormatOptions
Defines formatting options for the Plain Text format. The value is constrained to constants such as CharactersPerInch.
Example
77
</s:sequence> </s:complexType>
Related Topics
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:RangePromptVal ue" minOccurs="0" maxOccurs="unbounded"/> </s:sequence> <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.
Related Topics
DocumentRefreshOptions
RangePromptValue
Defines range prompt values for documents. The value is constrained to constants such as StartValue and EndValue.
78
Example
<s:complexType name="RangePromptValue"> <s:sequence> <s:element name="StartValue" type="s:string" minOc curs="0" maxOccurs="1"/> <s:element name="EndValue" type="s:string" minOc curs="0" maxOccurs="1"/> <s:attribute name="StartValueInclusive" default="true" type="s:boolean" use="optional"/> </s:sequence> <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. 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.
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.
79
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.
Related Topics
PromptInfo
RefreshStatus
Defines details such as RefreshStatus and Message.
Example
<s:complexType name="RefreshStatus"> <s:sequence> <s:element name="RefreshStatus" type="s1:RefreshSta tusEnum" minOccurs="1"/> <s:element name="Message" type="s:string" minOc curs="1"/> </s:sequence> </s:complexType>
Remarks
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:sequence> <s:element name="AllPageExported" type="s:boolean" minOccurs="0"/> <s:element name="StartPageNumber" type="s:int" minOc curs="0"/> <s:element name="EndPageNumber" type="s:int" minOc
80
CrystalReportFormatOptions
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" minOc curs="0"/> <s:element name="Delimiter" type="s:string" minOc curs="0"/> <s:element name="ExportMode" type="s1:ExportModeEnum" minOccurs="0"/> <s:element name="GroupSectionsOption" type="s1:Group SectionsOptionEnum" minOccurs="0"/> <s:element name="ReportSectionsOption" type="s1:Report SectionsOptionEnum" 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 .
81
Related Topics
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" minOc curs="0"/> <s:element name="Delimiter" type="s:string" minOc curs="0"/> <s:element name="ExportMode" type="s1:ExportModeEnum" minOccurs="0"/> <s:element name="GroupSectionsOption" type="s1:GroupSec tionsOptionEnum" minOccurs="0"/> <s:element name="ReportSectionsOption" type="s1:Report SectionsOptionEnum" minOccurs="0"/> </s:sequence> </s:complexType>
Related Topics
CrystalReportFormatOptions
URLHolder
Contains information about a document URL. The value is constrained to constants such as DocumentID and DocumentURL.
Example
82
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:element name="IncludeAsset" type="s:boolean" minOc curs="0"/> <s:element name="RefreshOnView" type="s:boolean" minOccurs="0"/> </s:sequence> </s:complexType>
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.
Related Topics
GetDocumentURL
WebiPrecacheType
Includes details such as OutputType and Locale.
83
Example
<s:complexType name="WebiPrecacheType"> <s:sequence> <s:element name="OutputType" type="s1:WebiPrecacheOut putTypeEnum" minOccurs="0"/> <s:element name="Locales" type="s:string" minOccurs="0" maxOccurs="unbounded"/> </s:sequence> </s:complexType>
Related Topics
WebiRefreshOptions
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"/> <s:element name="PrecacheTypes" type="s1:WebiPreca cheType" 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>
84
Remark
ViewingServerGroup is the name of the preferred or specified server group with which to view the refreshed report.
Related Topics
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" minOc curs="0"/> <s:element name="EndPageNumber" type="s:int" minOc curs="0"/> </s:sequence> </s:complexType>
Related Topics
CrystalReportFormatOptions
CrystalReportFormatOptions
Defines formatting options for Crystal Report documents. The value is constrained to constants such as WordFormatOptions, RichTextFormatOptions, ExcelFormatOptions, and so on.
Example
85
<s:element name="UseExportOptionsInReport" type="s:boolean" minOccurs="0"/> <s:element name="Format" type="s1:CrystalReportFor matEnum" minOccurs="0"/> <s:element name="ExcelFormatOptions" type="s1:Ex celFormatOptions" minOccurs="0"/> <s:element name="ExcelDataOnlyFormatOptions" type="s1:ExcelDataOnlyFormatOptions" minOccurs="0"/> <s:element name="WordFormatOptions" type="s1:WordFor matOptions" minOccurs="0"/> <s:element name="PDFFormatOptions" type="s1:PDFFor matOptions" 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"/> <s:element name="TabSeparatedTextFormatOptions" type="s1:TabSeparatedTextFormatOptions" minOccurs="0"/> </s:sequence> </s:complexType>
Related Topics
CrystalReportRefreshOptions
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.
86
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
<operation name="GetDocumentURL"> <input message="s1:GetDocumentURLIn"/> <output message="s1:GetDocumentURLOut"/> <fault name="BIWorkflowException" message="s1:FaultMes sage"/> </operation> <message name="GetDocumentURLIn"> <part element="s1:GetDocumentURL" name="parameters"/> </message> <message name="GetDocumentURLOut"> <part element="s1:GetDocumentURLResponse" name="param eters"/> </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>
Message input
87
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 SAP 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
88
ensures other applications that connect to this CMS are not affected. See also BIWorkflow ports and binding
Workflow specification for GetDocumentURL
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. None. 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.
Error Scenario
Business Rule
None.
89
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="SendDocument"> <input message="s1:SendDocumentIn"/> <output message="s1:SendDocumentOut"/> <fault name="BIWorkflowException" message="s1:FaultMes sage"/> </message> </operation> <operation name="parameters"/> <message name="SendDocumentOut"> <part element="s1:SendDocumentResponse" name="parame ters"/> </message> <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
90
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.
BPEL process sends a message to the web service specifying the document to send, the refresh options, and target file location. Normal Scenario Workflow 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.
91
Error Scenario
SendDocument sends an error message to the calling process when the file location is invalid, disabled, or inaccessible. 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.
Business Rule
Related Topics
RefreshDocument
EmailDocument
This operation allows documents to be emailed using specified SMTP options.
Example
<operation name="EmailDocument"> <input message="s1:EmailDocumentIn"/> <output message="s1:EmailDocumentOut"/> <fault name="BIWorkflowException" message="s1:FaultMes sage"/> </operation> <message name="EmailDocumentIn"> <part element="s1:EmailDocument" name="parameters"/> </message> <message name="EmailDocumentOut"> <part element="s1:EmailDocumentResponse" name="parame ters"/> </message> <s:element name="EmailDocument"> <s:complexType>
92
<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="DocumentRefreshOp tions" 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
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.
93
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. BIWorkflow operations and messages
BPEL process sends a message to the web service specifying the document to email, the refresh options, and SMTP options. Normal Scenario Workflow An email is sent to the recipients using the mailing options specified by calling process, and a copy of the document is attached. The service sends a newly created document to the recipients of the email as an attachment. EmailDocument sends an error message to the calling process under these circumstances: An invalid SMTP configuration exists.
Error Scenario
94
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.
PrintDocument
This operation allows documents to be printed using specified Printer options.
Example
<operation name="PrintDocument"> <input message="s1:PrintDocumentIn"/> <output message="s1:PrintDocumentOut"/> <fault name="BIWorkflowException" message="s1:FaultMes sage"/> </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:ele ment minOccurs="1" name="SecurityAsset" type="s:string"/> <s:ele ment minOccurs="1" name="URI" type="s:string"/> <s:ele ment minOccurs="0" name="DocumentRefreshOptions" type="s1:DocumentRefreshOptions"/>
95
<s:ele ment minOccurs="1" name="DocumentPrinterOptions" type="s1:DocumentPrinterOptions"/> </s:sequence> </s:complexType> </s:element> <s:element name="PrintDocumentResponse"> <s:complexType> <s:sequence> <s:ele ment minOccurs="1" name="ID" type="s:int"/> </s:sequence> </s:complexType> </s:element>
Message input
PrintDocumentOut 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. 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.
96
BPEL process sends a message to the web service specifying the document to email, the refresh options, and SMTP options. Normal Scenario Workflow The service refreshes the document when appropriate. A copy of the document is printed using the specified printer options. Alternative Scenario Workflow Not applicable. 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.
Error Scenario
Business Rule
If no printer information is provided, the possible printer control option, and the default page server setting is used.
97
CheckRefreshStatus
This operation returns the status of a refresh operation on a specified document.
Example
<operation name="CheckRefreshStatus"> <input message="s1:CheckRefreshStatusIn"/> <output message="s1:CheckRefreshStatusOut"/> <fault name="BIWorkflowException" message="s1:FaultMes sage"/> </operation> <message name="CheckRefreshStatusIn"> <part element="s1:CheckRefreshStatus" name="parameters"/> </message> <message name="CheckRefreshStatusOut"> <part element="s1:Check RefreshStatusResponse" 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>
98
</s:complexType> </s:element>
Message input
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.
Related Topics
GetDocumentURL
FireEvents
This operation ensures that events are correctly triggered.
Note:
99
Example
<operation name="FireEvents"> <input message="s1:FireEventsIn"/> <output message="s1:FireEventsOut"/> <fault name="BIWorkflowException" message="s1:FaultMes sage"/> </operation> <message name="FireEventsIn"> <part element="s1:FireEvents" name="pa rameters"/> </message> <message name="FireEventsOut"> <part element="s1:FireEventsResponse" name="parameters"/> </message> <s:element name="FireEvents"> <s:complexType> <s:sequence> <s:ele ment minOccurs="1" name="SecurityAsset" type="s:string"/> <s:ele ment minOccurs="1" name="uri" type="s:string"/> </s:sequence> </s:complexType> </s:element> <s:element name="FireEventsResponse"> <s:complexType/> </s:element>
Message input
FireEventsOut
Remarks
100
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 .
BPEL process sends a message to the web service to integrate the service with events to fire. Not applicable. FireEvent sends an error message to the calling process under these circumstances: The current security context has insufficient rights to add new users to BusinessObjects Enterprise.
Error Scenario
The events specified in the message are not presented, or they are of an inappropriate type.
Business Rule
None.
RefreshDocument
This operation creates an instance of a document with the latest available data.
101
Example
<operation name="RefreshDocument"> <input message="s1:RefreshDocumentIn"/> <output message="s1:RefreshDocumentOut"/><fault name="BIWorkflowException" message="s1:FaultMessage"/> </operation> <message name="RefreshDocumentIn"> <part element="s1:RefreshDocument" name="parameters"/> </message> <message name="RefreshDocumentOut"> <part element="s1:RefreshDocumentResponse" name="parame ters"/> </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
102
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.
Workflow specification for RefreshDocument BPEL process sends a message to the web service to integrate the service with events to fire.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. Normal Scenario Workflow 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.
103
Business Rule
None.
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: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> </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.
Related Topics
CheckRefreshStatus
104
Example
<binding name="BIWorkflowBinding" type="s1:BIWorkflow Port"> <soap:binding style="document" trans port="http://schemas.xmlsoap.org/soap/http"/> <operation name="GetDocumentURL"> <soap:operation soapAction="http://biwork flow.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="liter al"/> </fault> </operation> <operation name="SendDocument"> <soap:operation soapAction="http://biwork flow.dsws.businessobjects.com/2006/06/01/SendDocument" style="document"/> <input> <soap:body use="literal"/> </input> <output> <soap:body use="literal"/> </output> <fault name="BIWorkflowException"> <soap:fault name="BIWorkflowException" use="liter al"/> </fault> </operation> <operation name="EmailDocument"> <soap:operation soapAction="http://biwork flow.dsws.businessobjects.com/2006/06/01/EmailDocument" style="document"/> <input> <soap:body use="literal"/> </input> <output>
105
<soap:body use="literal"/> </output> <fault name="BIWorkflowException"> <soap:fault name="BIWorkflowException" use="liter al"/> </fault> </operation> <operation name="PrintDocument"> <soap:operation soapAction="http://biwork flow.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="liter al"/> </fault> </operation> <operation name="RefreshDocument"> <soap:operation soapAction="http://biwork flow.dsws.businessobjects.com/2006/06/01/RefreshDocument" style="document"/> <input> <soap:body use="literal"/> </input> <output> <soap:body use="literal"/> </output> <fault name="BIWorkflowException"> <soap:fault name="BIWorkflowException" use="liter al"/> </fault> </operation> <operation name="CheckRefreshStatus"> <soap:operation soapAction="http://biwork flow.dsws.businessobjects.com/2006/06/01/CheckRefreshSta tus" style="document"/> <input> <soap:body use="literal"/> </input> <output> <soap:body use="literal"/> </output> <fault name="BIWorkflowException"> <soap:fault name="BIWorkflowException" use="liter al"/> </fault> </operation>
106
<operation name="FireEvents"> <soap:operation soapAction="http://biwork flow.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="liter al"/> </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.
Related Topics
BIWorkflow service
BIWorkflow service
The BIWorkflow service groups the BIWorkflow ports.
Example
<service name="BIWorkflow"> <documentation>BIWorkflow Web Service</documentation> <port name="BIWorkflow" binding="s1:BIWorkflowBinding"> <soap:address location="http://localhost:8080/dsws/ser vices/biworkflow"/> </port> </service>
107
Related Topics
BIWorkflow namespace
The following XML namespace URI is used when the BIWorkflow specification is implemented: targetNamespace="http://biworkflow.dsws.businessob jects.com/2006/06/01/">
108
Tutorial
Tutorial Preconditions
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.
Preconditions
To use the services provided by the Business Process BI Services, you will need the following: BusinessObjects Enterprise XI 3.x (or later). BPEL Process Manager. A web application server. JDK 1.5 (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. 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
110
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.
If the "Happiness" page fails to appear or displays an error message, your webapps has failed to deploy. For more information about how to manually deploy your webapps, see the BusinessObjects Install Guide.
111
Example:
The axis2.xml file is where the default user name and password for accessing the Apache Axis Admin console is stored. The default Apache Axis2 username is admin and password is axis2. You must change this default password after your first logon. To change your Axis2 password, edit the password property the axis2.xml file. You must save your changes and restart your web application server for the modifications to take effect.
Note:
The axis2.xml file is a part of the WAR file. The default location of the axis2.xml file is as follows: \Program Files\Business Objects\Tomcat\webapps\dswsbobje\WEB-INF\conf .
112
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 BISecurity. 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 BISecurityPortLink and in the Partner role field, type BISecurityPortProvider. 6. For this tutorial, leave the MyRole field blank. 7. Click OK or Done.
Note:
To check that the BISecurity file has been integrated with the BPM tool, and to view the services that BISecurity provides, click Overview 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.
113
The Create partnerlink page opens. 3. In the Name field for the partnerlink, type BIWorkflow. 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 BISecurityPortLink. Then, in the Partner role field, type BISecurityPortProvider. 6. For this tutorial, leave the MyRole field blank. 7. Click OK or Done.
Note:
To check that the BIWorkflow file has been integrated with the BPM tool, and to view the services that BIWorkflow provides, click Overview 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.
114
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 ComponentPalette 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 CreateSecurityAsset. 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 CreateSecurityAssetInput. Click Done or OK. f. In the outputVariable field, select Create Global variable. The New Variable Wizard page opens. g. In the Variable name field, type CreateSecurityAssetOutput. h. Click Done or OK. After adding a CreateSecurityAsset invoke activity, you will need to populate the asset as shown in To add a PopulateSecurityInfo assign activity
115
a. In the Expression field, type 'secEnterprise'. b. In the To field, expand the Variable, Part and Query node. c. Go to CreateSecurityAssetInput\parameters\CreateSecurityAs set\LogonInfo, and click AuthenticationType. d. Click Done. 5. Click Add Copy Rule. In the Copy Rule dialog box, do the following: a. In the Expression field, type '<your_user_name>'. Substitute your Central Management Console user name for <your_user_name>. For example: 'Administrator'. b. In the To field, expand the Variable, Part and Query node. c. Go to CreateSecurityAssetInput\parameters\CreateSecurityAs set\LogonInfo, and click AccountName. d. Click Done. 6. Click Add Copy Rule. In the Copy Rule dialog box, do the following: a. In the Expression field, type '<Password>' Substitute your password for <Password>. b. In the To field, expand the Variable, Part and Query node. c. Go to CreateSecurityAssetInput\parameters\CreateSecurityAs set\LogonInfo, and click Password. d. Click Done. 7. Click Add Copy Rule. In the Copy Rule dialog box, do the following: a. In the Expression field, type '<your_machine_name>'. your machine name for <your_machine_name>. b. In the To field, expand the Variable, Part and Query node. c. Go to CreateSecurityAssetInput\parameters\CreateSecurityAs set\LogonInfo, andclick Domain. d. Click Done. Filling in details for the PopulateSecurityInfo assign activity will set the values of the parameters that are required for invoking the CreateSecurityAsset method. The PopulateSecurityInfo procedure is
116
required as an initial step for the integration of any business process model with the Business Process BI Services. You may want to assign values to the rest of the parameters under CreateSecurityAsset and AssetLifeSpanOptions before you proceed to the next step. After adding a PopulateSecurityInfo invoke activity, you may add any BISecurity or BIWorkflow service such as GetDocumentURL as shown in To add a GetDocumentURL invoke activity. In this project, you will need to add a scope activity before adding other services to ensure the variables defined may be accessed.
117
118
4. Click Add Copy Rule. In the Copy Rule dialog box, do the following: a. In the Expression field, type the URI Path. For example: path://InfoObjects/Root Folder/Report Samples/Feature Examples/Accessibility For more information about the URI path, see the Platform Web Services (WS) Software Development Toolkit (SDK) User Guide. b. In the To field, expand the Variable, Part and Query node. c. Go to GetDocumentURLIn\ parameters\GetDocumentURL, and click URI. d. Click Done. 5. Click Add Copy Rule. The Copy Rule dialog box opens. In the Copy Rule dialog box, do the following: a. In the Expression field, type 'true()' or 'false()' depending on whether the generated URL must include appropriate authentication information from the security asset. b. In the To field, expand the Variable, Part and Query node. c. Go to GetDocumentURLIn\parameters\GetDocumen tURL\URLViewOptions, and click IncludeAsset. d. Click Done. 6. Click Add Copy Rule. The Copy Rule dialog box opens. In the Copy Rule dialog box, do the following: a. In the Expression field, type 'true()' or 'false()' depending on whether you would like the generated URL to show a version of the document with the most up-to-date information. b. In the To field, expand the Variable, Part and Query node. c. Go to GetDocumentURLIn\parameters\GetDocumen tURL\URLViewOptions, and click RefreshOnView. d. Click Done. 7. Click Add Copy Rule. The Copy Rule dialog box opens.
119
In the Copy Rule dialog box, do the following: a. In the Expression field, type 'true()' or 'false()' depending on whether you would like the document to be refreshed before the URL is obtained. b. In the To field, expand the Variable, Part and Query node. c. Go to GetDocumentURLIn\parameters\GetDocumentURL\ DocumentRefreshOptions, and click Refresh. d. Click Done. 8. Click Add Copy Rule. The Copy Rule dialog box opens. In the Copy Rule dialog box, do the following: a. In the Expression field, type '<your_format_type>'. Substitute your format type for <your_format_type>. For example: 'CRYSTAL_REPORT'. b. In the To field, expand the Variable, Part and Query node. c. Go to GetDocumentURLIn\parameters\GetDocumentURL\ Docu mentRefreshOptions\CrystalReportsRefreshOptions\FormatOp tions, and click Format. 9. Click Add Copy Rule. The Copy Rule dialog box opens. In the Copy Rule dialog box, do the following: a. In the Expression field, type '<your_viewing_serv er_group_choice>'. Substitute your viewing server group choice for <your_viewing_server_group_choice>. For example: 'FIRST_AVAILABLE'. b. In the To field, expand the Variable, Part and Query node. c. Go to GetDocumentURLIn\parameters\GetDocumentURL\ DocumentRefreshOptions, and click ViewingServerGroupChoice. 10. Click Add Copy Rule. The Copy Rule dialog box opens. In the Copy Rule dialog box, do the following:
120
a. In the Expression field, type 'true()' or 'false()' depending on your whether you would like to use the default formatting options that Crystal Report specify rather than the options specified in the request. b. In the To field, expand the Variable, Part and Query node. c. Go to GetDocumentURLIn\parameters\GetDocumentURL\ Docu mentRefreshOptions\CrystalReportsRefreshOptions\FormatOp tions, and click UseExportOptionsInReport. 11. Click Add Copy Rule. The Copy Rule dialog box opens. In the Copy Rule dialog box, do the following: a. In the Expression field, type '<your_server_name>'. Substitute your machine name for <your_server_name>. For example: 'Xtreme Sample Database 11.5'. This sets the database server name so that the refresh process knows where to get the refreshed data from. b. In the To field, expand the Variable, Part and Query node. c. Go to GetDocumentURLIn\parameters\GetDocumentURL\ Docu mentRefreshOptions\CrystalReportsRefreshOptions\DBLogons, and click ServerName. 12. Click Add Copy Rule. The Copy Rule dialog box opens. In the Copy Rule dialog box, do the following: a. In the Expression field, type '<your_user_name>'. Substitute your user name for '<your_user_name>'. For example: 'Administrator'. b. In the To field, expand the Variable, Part and Query node. c. Go to GetDocumentURLIn\parameters\GetDocumentURL\ Docu mentRefreshOptions\CrystalReportsRefreshOptions\DBLogons, and click UserName. 13. Click Add Copy Rule. The Copy Rule dialog box opens.
121
In the Copy Rule dialog box, do the following: a. In the Expression field, type '<Password>'. Substitute your password for '<Password>'. b. In the To field, expand the Variable, Part and Query node. c. Go to GetDocumentURLIn\parameters\GetDocumentURL\ Docu mentRefreshOptions\CrystalReportsRefreshOptions\DBLogons, and click Password. 14. Click Add Copy Rule. The Copy Rule dialog box opens. In the Copy Rule dialog box, do the following: a. In the Expression field, type 'true()' to force a refresh of the document. b. Go to GetDocumentURLIn\parameters\GetDocumentURL\ DocumentRefreshOptions, and click Refresh. 15. Click Add Copy Rule. The Copy Rule dialog box opens. In the Copy Rule dialog box, do the following: a. In the From field, expand the Variable, Part and Query node. b. Go to CreateSecurityAssetOut\parameters\CreateSecurityAsse tResponse, and click SecurityAsset. c. In the To field, expand the Variable, Part and Query node. d. Go to CheckRefreshStatusIn\parameters\CheckRefreshStatus, and click SecurityAsset. As a general rule, ConsumeAsset is preceded by PopulateSecurityInfo and CreateSecurityAsset. The ConsumeAsset procedure may be followed by procedures to invoke any of the BIWorkflow or BISecurity services, such as GetDocumentURL, as shown in To add a GetDocumentURL invoke activity.
122
Enabling Clustering
To work with a provider of Business Objects web services that uses clustering, consumers of the web service must maintain their session state. Clustering is done automatically if the consumer application uses the Business Objects web services Consumer API that is shipped with BusinessObjects Enterprise XI 3.x. If the consumer application uses a consumer that is generated from the WSDL, the session must be maintained manually.
Example: Maintaining session state using J2EE
123
To enable clustering
Edit the BusinessProcessBI.properties file by changing the value for the clustered parameter to true.
Example:
clustered = true
Note: The BusinessProcessBI.properties file is a part of the war file. The default location of the BusinessProcessBI.properties file is as follows:
\Program Files\Business Objects\ Tomcat\webapps\Busi nessProcessBI\WEB-INF\classesTomcat. For information about how to set up your application servers with clustering enabled, see your application server documentation.
Example: Note: For more information about pre-defined log levels, see the The Business Process BI Services Logger section in the Overview of Business Process BI Services chapter.
124
For more information about pre-defined log levels, see the The Business Process BI Services Logger section in the Overview of Business Process BI Services chapter. For more information about pre-defined log levels, see the The Business Process BI Services Logger section in the Overview of Business Process BI Services chapter. businessobjects.logs.home=<path to new log file folder> Substitute the path to the new log file folder for <path to new log file folder> . Once this change has been made, the web application server must be restarted to allow the log to be stored in the new location specified in the configuration file from that point.
Note:
To set the system properties for the Business Process BI Services logger
System properties are key/ value pairs that define traits or attributes for the current working environment. Set the trace JVM system property to true as follows: crystal.re port.rassdk.trace=true.
125
126
Business Objects offers a full documentation set covering all products and their deployment. The online documentation library has the most up-to-date version of the Business Objects product documentation. You can browse the library contents, do full-text searches, read guides on line, and download PDF versions. The library is updated regularly with new content as it becomes available. http://help.sap.com/
Additional developer resources
https://boc.sdn.sap.com/developer/library/
Online customer support
The Business Objects Customer Support web site contains information about Customer Support programs and services. It also has links to a wide range of technical information including knowledgebase articles, downloads, and support forums. http://www.businessobjects.com/support/
Looking for the best deployment solution for your company?
Business Objects consultants can accompany you from the initial analysis stage to the delivery of your deployment project. Expertise is available in relational and multidimensional databases, in connectivities, database design tools, customized embedding technology, and more. For more information, contact your local sales office, or contact us at: http://www.businessobjects.com/services/consulting/
Looking for training options?
From traditional classroom learning to targeted e-learning seminars, we can offer a training package to suit your learning needs and preferred learning style. Find more information on the Business Objects Education web site: http://www.businessobjects.com/services/training
128
Do you have a suggestion on how we can improve our documentation? Is there something you particularly like or have found useful? Drop us a line, and we will do our best to ensure that your suggestion is included in the next release of our documentation: mailto:documentation@businessobjects.com
Note:
If your issue concerns a Business Objects product and not the documentation, please contact our Customer Support experts. For information about Customer Support visit: http://www.businessobjects.com/support/.
For information about the full range of Business Objects products, visit: http://www.businessobjects.com.
129
130
More Information
More Information
Information Resource
Location
Select http://help.sap.com > SAP BusinessObjects. You can access the most up-to-date documentation covering all SAP BusinessObjects products and their deployment at the SAP Help Portal. You can download PDF versions or installable HTML libraries.
SAP Help Portal
Certain guides are stored on the SAP Service Marketplace and are not available from the SAP Help Portal. These guides are listed on the Help Portal accompanied by a link to the SAP Service Marketplace. Customers with a maintenance agreement have an authorized user ID to access this site. To obtain an ID, contact your customer support representative. http://service.sap.com/bosap-support > Documentation
Installation guides: https://service.sap.com/bosap-inst guides Release notes: http://service.sap.com/releasenotes
The SAP Service Marketplace stores certain installation guides, upgrade and migration guides, deployment guides, release notes and Supported Platforms documents. Customers with a maintenance agreement have an authorized user ID to access this site. Contact your customer support representative to obtain an ID. If you are redirected to the SAP Service Marketplace from the SAP Help Portal, use the menu in the navigation pane on the left to locate the category containing the documentation you want to access. https://boc.sdn.sap.com/
Developer resources
https://www.sdn.sap.com/irj/sdn/businessobjects-sdklibrary
132
More Information
Information Resource
Location
SAP BusinessObjects articles https://www.sdn.sap.com/irj/boc/businessobjects-articles on the SAP Community NetThese articles were formerly known as technical papers. work
https://service.sap.com/notes
Notes
http://www.sap.com/services/education
Training
From traditional classroom learning to targeted e-learning seminars, we can offer a training package to suit your learning needs and preferred learning style. http://service.sap.com/bosap-support The SAP Support Portal contains information about Customer Support programs and services. It also has links to a wide range of technical information and downloads. Customers with a maintenance agreement have an authorized user ID to access this site. To obtain an ID, contact your customer support representative. http://www.sap.com/services/bysubject/businessobjectscon sulting
Consulting
Consultants can accompany you from the initial analysis stage to the delivery of your deployment project. Expertise is available in topics such as relational and multidimensional databases, connectivity, database design tools, and cus tomized embedding technology.
133
More Information
134