Installing Adobe LiveCycle ES3 Data Services for JEE, Version 4.6

© 2012 Adobe Systems Incorporated and its licensors. All rights reserved.


Contents

Setting up clients

Flex

To compile an application, Flash Builder and mxmlc reference the SWC library files that ship with the Flex SDK in subdirectories of the frameworks directory. In Flash Builder, the frameworks directories for different Flex SDK versions are in the install_root/sdks/sdk_version directory.

Data Services ships with a set of SWC files that are compatible with the Flex SDK included in the version of Flash Builder that is made available as part of this preview program.

To add the Data Services SWC files to the Flash Builder or mxmlc library path, copy the subdirectories of the install_root/resources/client-sdk/flex directory to the Flex SDK frameworks directory in Flash Builder.

For information about building and running Flex clients, see Using LiveCycle Data Services.

Android

For information about building and running Java-based and AIR-based Android clients with Data Services, see "Create mobile and web applications" in Using LiveCycle Data Services.

Java

For information about building and running Java clients with Data Services, see "Creating a Java Desktop application that invokes Data Services" in Using LiveCycle Data Services.

HTML5/JavaScript

For information about building and running HTML5/JavaScript clients with Data Services, see "Create mobile and web applications" in Using Data Services.

iOS

To build and run an iOS client application that uses the Data Services iOS SDK, you must have version 3.2.5 or later of the Apple Xcode integrated development environment running on MacOS. For more information about Xcode and the exact versions of MacOS supported, see:http://developer.apple.com/technologies/tools.

Additionally, if you want to install your application to a device instead of the iOS simulator, you must purchase a developer
license from Apple. More information about this is available at:http://developer.apple.com.

The following instructions assume some level of familiarity with Xcode and general iOS development techniques. These instructions apply equally to
an existing project in which you want to use Data Services iOS SDK or a new project.

  1. Unzip dataservices-client-iOS.zip from install_root/resources/client-sdk/iOS/ to
    install_root/resources/client-sdk/iOS/dataservices-client-iOS.
  2. Open your existing project in Xcode or create a new Xcode project according to your requirement. The new project must be an iOS
    project and will typically be one of the many application type projects that Xcode allows you to create.
  3. Add the DSClient framework to your project from install_root/resources/client-sdk/iOS/dataservices-client-iOS.
    To add frameworks, you can either drag & drop or right-click Frameworks=>Add=>Existing Frameworks… (Xcode 3.2.5), right-click Frameworks=>Add Files to "<Project>" (Xcode 4).
  4. Add the CFNetwork framework to your project.
  5. You can import headers selectively or import <DSClient/DSClient.h>. The latter imports all public headers in the SDK,
    just like <Foundation/Foundation.h> imports all Core Foundation headers.
  6. In your project's settings, add the "-all_load" flag to the linker settings (in "Other Linker Flags").

The all_load setting is required because there is a category on NSDictionary and NSArray in a static library,
and without this switch, the linker optimizes it out because it doesn't see any class methods.
You can find details here: http://developer.apple.com/library/mac/#qa/qa2006/qa1490.html.

The SDK provides two sample applications along with source: the Remoting Demo and the Trader Desktop.
The Remoting Demo is a simple view-based application that invokes an echo service on the server via remoting with some text
typed in a text field. The Trader Desktop sample application is a more advanced example of how to use the messaging features
of the SDK. See the readme.txt in each sample directory for detailed instructions.

For information on building and running an iOS client for Data Services, see "Creating Data Services iDevice Applications" in Using LiveCycle Data Services.

Installing the application modeling plug-in

The Modeler, also known as the application modeling plug-in, is a tool for creating and editing Adobe application modeling technology models. The Modeler is available with the downloads. It consists of a set of Eclipse plug-ins in the lces_data_services_JEE_4_6_1_all_modeler_plugin.zip file that you install into a stand-alone Flash Builder installation.

System Requirements

The download supports the application modeling plug-in with Flash Builder 4.6 on the following operating systems:

Stand-alone Flash Builder Installation (Windows and Macintosh)

  1. Launch Flash Builder 4.6.
  2. Select Help > Install New Software.
  3. Click Add.
  4. Click Archive.
  5. Navigate to the directory that contains the lces_data_services_JEE_4_6_1_all_modeler_plugin.zip file.
  6. Select the lces_data_services_JEE_4_6_1_all_modeler_plugin.zip file.
  7. Click Open.
  8. Click OK.
  9. Check the checkbox next to LiveCycle Data Services Modeler for Flash Builder.
  10. Click Next.
  11. Click Next again.
  12. Review the License Agreement. Click Accept.
  13. Click Finish.
  14. If prompted with a security warning about unsigned software, click OK to continue with the installation.
  15. When prompted, restart Flash Builder.

Installing LiveCycle Data Services

Data Services for JEE runs as a JEE web application.

Note: There is no longer a separate installation option for Data Services web applications. All of the installers with the exception of AIX and HP-UX installers, install the integrated Apache Tomcat application server. All of the Web Application Archive (WAR) files are included in the root
directory of the installation. Copy or move these WAR files to install to a separate
standalone application server.

System Requirements

The download supports Data Services installations on the following operating systems:

The download supports Data Services installations on the following application server:

The installers include the following Web Application Archive (WAR) files:

Each WAR file is a separate, stand-alone web application. If you are using the JEE web applications configuration, you must have an existing JEE application server or servlet container available and understand web application deployment. If you do not have an existing JEE server or are not familiar with WAR file deployment, use the integrated Tomcat configuration to get started.

These installation instructions refer to the root directory where you installed Data Services as install_root.

Data Services with integrated Apache Tomcat application server

The Data Services with integrated Tomcat installation option contains the following files and directories under the installation root:

readme.htm Contains overview information.
dataservices.war Data Services web application template, used as a starting point for new applications.
dataservices-samples.war Data Services sample applications.
ds-console.war Simple monitoring application for Data Services deployments.
dataservices-spring.war Data Services Spring based web application template, used as a starting point for new applications.
dataservices-samples-spring.war Data Services sample applications using Spring.
license.txt License information.
/tomcat Contains an installation of Apache Tomcat that includes Data Services, dataservices-samples, and console web applications expanded and deployed in the default server.
/resources Fully commented configuration files, and directories and files used for security, clustering, Flex Ajax Bridge, and WSRP.
/sampledb Contains an HSQLDB database used by the sample applications.

Install Data Services in the integrated Tomcat configuration

  1. Start the installation program. Do one of the following, depending on your operating system:
  2. Accept the license agreement.
  3. Specify the directory in which to install Data Services or accept the default location.
  4. Complete the remaining installer steps.
  5. To start Data Services, open a command window, navigate to install_root/tomcat/bin, and enter the command: catalina run.
    On Microsoft Windows, you can start Data Services from the Start menu, or navigate to the install_root/tomcat/bin in Windows Explorer and double-click the startup.bat icon.

Running the sample applications with the integrated Tomcat installation

When you install Data Services, the installer creates the dataservices-samples web application that contains sample applications, including the 30 Minute Test Drive application. The sample applications demonstrate basic capabilities and best practices for developing Data Services applications.

  1. The Data Services sample applications use an HSQLDB database that is installed in the install_root/sampledb directory. To start the sample database:
  2. Start Tomcat (startup.bat or startup.sh in /lcds461/tomcat/bin)
  3. Open a browser window.
  4. Access the samples home page by opening the following URL in a browser:
    http://localhost:8400/dataservices-samples/
  5. Access the 30 Minute Test Drive application by opening the following URL in a browser:
    http://localhost:8400/dataservices-samples/testdrive.htm
  6. Access the Spring samples home page by opening the following URL in a browser:
    http://localhost:8400/dataservices-samples-spring/

Deploying Data Services on other application servers

Deploy the dataservices.war, dataservices-samples.war, ds-console.war, dataservices-spring.war, and dataservices-samples-spring.war web applications by using your application-server-specific deployment method. For example, for Tomcat, copy the web application to the webapps directory and restart the server. 

Notes:
To use the model-driven development features, you must deploy the web applications as expanded directories rather than WAR files. For production, you can package web applications in compressed WAR files.

Many samples applications in dataservices-samples web application require that you deploy the web application as an expanded directory structure. When you deploy the dataservices-samples web application, make sure that you specify "dataservices-samples" as the context-root.

Additional server-specific configuration

There are additional configuration steps for the following application server:

Tomcat

To use Data Services with Tomcat when not using the integrated Tomcat configuration, install support for the Java Transaction API (JTA). You might also have to install several other libraries depending on the features that you plan to use. Follow these steps after deploying the Data Services WAR files. These steps are not necessary for the integrated Tomcat installation.

  1. Stop Tomcat.
  2. To install support for JTA, a recommended implementation is the Java Open Transaction Manager (JOTM), which is a fully functional open source stand-alone transaction manager.
    1. Download JOTM from http://jotm.objectweb.org/.
    2. Copy the JAR files from jotm-root/lib to [tomcat-root]/common/lib.
    3. Create a context file for your web application and register JOTM using the Transaction element. For example, for the samples WAR create a tomcat-root/conf/Catalina/localhost/dataservices-samples.xml file and add the following lines:
      <context antijarlocking="false" antiresourcelocking="false"   docbase="${catalina.home}/webapps/dataservices-samples" path="/dataservices-samples"   privileged="true">  <transaction factory="org.objectweb.jotm.UserTransactionFactory"   jotm.timeout="60"></transaction></context>  
      Note: If a context file exists for your web application, add the <TRANSACTION> element under the <context> element.
  3. Increase the maximum memory to at least 512 MB by specifying the maximum heap size for the JVM in the JAVA_OPTS variable: -Xmx512m
  4. (Optional) To enable custom authentication, locate the Tomcat security resource libraries under install_root/resources/security/tomcat.
    1. Place the flex-tomcat-common.jar and flex-tomcat-server.jar files in the tomcat/lib folder.
    2. Add the following line to the context descriptor file for your web application:

      <valve classname="flex.messaging.security.TomcatValve"></valve>

      You can now perform authentication against the current Tomcat realm. Usually, the default configuration for authentication stores user information in conf/tomcat-users.xml. See the Tomcat documentation for more information on realms. See the Data Services documentation for more information on custom authentication.

    3. You might also have to update the active <login-command> in /WEB-INF/flex/services-config.xml in each deployment of a Data Services WAR file. For Tomcat, ensure that the TomcatLoginCommand is active in the <security>section:
      <security><loging-command server="Tomcat"></login-command>...</security>
  5. (Optional) To use the JMSAdapter with the Message Service, install and configure a JMS provider (such as ActiveMQ or openJMS) for use with Tomcat.
  6. Restart Tomcat.

Configuring ActiveMQ 4.1.1 with Tomcat 6.0.x

These instructions create a configuration that matches what is distributed with Data Services. You can integrate Apache ActiveMQ 4.1.1 with earlier versions of Tomcat. You can integrate newer versions of ActiveMQ with Tomcat 6.0.x, but none of these configurations have been tested. These instructions require that you have a valid Apache Ant installation.

  1. Download ActiveMQ 4.1.1 from http://activemq.apache.org/.
  2. Download and install the ActiveMQ distribution following the instructions provided on the ActiveMQ website.
  3. ActiveMQ ships with an example that contains the JAR files and configuration settings that work with a web application deployment. Build the example by opening a command prompt, changing to the activemq_root/example directory and running the following command to build the example:
    ant war
  4. In the tomcat_root/lib directory, create a directory called activemq4.1.1. Copy the contents of the activemq_root/example/target/activemq-web/WEB-INF/lib directory to this new directory.
  5. Open the catalina.properties file from the tomcat_install/conf directory in a text editor. Modify the common.loader property by adding the following to the list of comma-separated paths:
    ${catalina.home}/lib/activemq4.1.1/*.jar
  6. Modify your Data Services web application to start an ActiveMQ message broker when the web application starts. To do so, open the WEB-INF/web.xml file for your web application in a text editor. Add the following context-param and listener elements. Make sure that you place them in the correct location within the web.xml. The order of these parameters and elements must match the web-app DTD.
    <context-param>
      <param-name>brokerURI</param-name>
      <param-value>/WEB-INF/activemq.xml</param-value>
    </context-param>
    <listener>
      <listener-class>org.apache.activemq.web.SpringBrokerContextListener</listener-class>
    </listener>
  7. In the WEB-INF directory of your web application, create a file called activemq.xml. Open the file in a text editor and add the following text:
    <beans>
    <broker brokername="myBroker" persistent="false" usejmx="true"
    xmlns="http://activemq.org/config/1.0">
    <transportconnectors>
    <transportconnector name="default" uri="tcp://localhost:61716">
    </transportconnector>
    </transportconnectors></broker>
    </beans>  

    This configuration starts an ActiveMQ message broker with a broker name of myBroker listening for requests on the localhost network interface at port 61716.

  8. Add the ActiveMQ connection factories and any JMS Topics and Queues to JNDI. In Tomcat 6.0.x, create a context file for your web application in the tomcat_install/conf/Catalina/localhost directory. If the Catalina/localhost directory does not exist, create it now. The file that you create must have the same name as the web application with a .xml extension. For example, if your Data Services web application is named samples, name the Tomcat context file samples.xml. For more information on context files, see your Tomcat documentation. After you create the file, open it in a text editor. Add the following contents to the file, replacing the example topic and queue shown here with your own topics and queues:
    <Context antijarlocking="false" antiresourcelocking="false"
    privileged="true" reloadable="true">
    <Resource brokername="myBroker" brokerurl="tcp://localhost:61716"
    description="JMS Connection Factory"
    factory="org.apache.activemq.jndi.JNDIReferenceFactory"
    name="jms/flex/TopicConnectionFactory"
    type="org.apache.activemq.ActiveMQConnectionFactory">
    </Resource>
    <Resource description="my Topic" factory="org.apache.activemq.jndi.JNDIReferenceFactory"
    name="jms/topic /flex/simpletopic"
    physicalname="FlexTopic" 
    type="org.apache.activemq.command.ActiveMQTopic">
    </Resource>
    <Resource brokername="myBroker"
    brokerurl="tcp://localhost:61716"
    description="JMS Connection Factory"
    factory="org.apache.activemq.jndi.JNDIReferenceFactory"
    name="jms/flex/QueueConnectionFactory" 
    type="org.apache.activemq.ActiveMQConnectionFactory">
    </Resource>
    <Resource description="my Queue" 
    factory="org.apache.activemq.jndi.JNDIReferenceFactory"
    name="jms/queue/flex/simplequeue" physicalname="FlexQueue" 
    type="org.apache.activemq.command.ActiveMQQueue">
    </Resource>
    <Valve classname="flex.messaging.security.TomcatValve"></Valve>
    </Context>  
  9. Start your Tomcat server. The ActiveMQ message broker starts listening for messages on port 61716. You can send messages to and receive messages from the JMS topics and queues that you configured. For more information about configuring and using ActiveMQ, see the ActiveMQ documentation available on http://activemq.apache.org/.


Running Data Services from a compressed WAR

  1. Expand a Data Services WAR file using software such as WinZip or the JAR utility.
  2. Create your application, including SWF files, ActionScript files, configuration settings, and HTML files.
  3. Create a compressed WAR file from the expanded web application structure.
  4. Deploy the compressed WAR file.

    Note: Many samples applications in dataservices-samples.war file do not function within a compressed web application. Therefore, it is advised that you deploy the dataservices-samples web application as an expanded directory structure. If you uncompress a WAR file into a subdirectory that you create, that subdirectory must match the name of the prefix of the WAR file. That directory is also the context root of the web application. To use the model-driven development features, you must deploy the web applications as expanded directories rather than WAR files; For production, you can package web applications in compressed WAR files.

WebLogic

There is a known Hibernate integration issue for most WebLogic versions. The LiveCycle Data Services model-driven development and Hibernate assembler features use Hibernate. The easiest solution is to put the antlr and hibernate-jpa files shipped with Data Services 4.6 in the WebLogic bootstrap classpath. The JAR files are in the WEB-INF/lib directory of the Data Services web applications.

To work around the issue, you need to add the hibernate-jpa-2.0-api-1.0.0.Final.jar and antlr-2.7.6.jar to the bootclasspath in the WebLogic start script, for example,

-Xbootclasspath/p:%DOMAIN_HOME%/applications/qa-regress/WEB-INF/lib/antlr-2.7.6.jar;%DOMAIN_HOME%/applications/qa-regress/WEB-INF/lib/hibernate-jpa-2.0-api-1.0.0.Final.jar

WebSphere

To use the Data Services NIO Server or standalone NIO endpoints (including RTMP) on WebSphere, the NIO server or NIO Endpoints must have access to a WebSphere WorkManager.

Configure LiveCycle Data Services for use with WebSphere

  1. Expand a LiveCycle Data Services WAR file to a temporary folder:jar -xvf data-services.war
  2. Uncomment the resource-ref element for the WorkManager in the web.xml file. This setting makes the resource available in java:comp/env/ at res-ref-name (java:comp/env/wm/MessagingWorkManager):

<resource-ref>
<description>Messaging WorkManager</description>
<res-ref-name>wm/MessagingWorkManager</res-ref-name>
<res-type>com.ibm.websphere.asynchbeans.WorkManager</res-type>
<res-auth>Container</res-auth>
<res-sharing-scope>Shareable</res-sharing-scope>
</resource-ref>

  1. Map the WorkManager resource-ref in the web.xml file to the NIO Server or NIO Endpoint in [dataservices-webapp-root]/WEB-INF/flex/services-config.xml. The websphere-workmanager-jndi-name maps to the res-ref-name available in java:comp/env in step 2.

For example, for an NIO server:
<server id="my-nio-server" class="flex.messaging.socketserver.SocketServer">
<properties>
<websphere-workmanager-jndi-name>java:comp/env/wm/MessagingWorkManager</websphere-workmanager-jndi-name>
</properties>
</server>

Or, for example, for an NIO endpoint:

<channel-definition id="my-rtmp" class="mx.messaging.channels.RTMPChannel">

<endpoint url="rtmp://{server.name}:2037" class="flex.messaging.endpoints.RTMPEndpoint"/>

<properties>
<websphere-workmanager-jndi-name>java:comp/env/wm/MessagingWorkManager</websphere-workmanager-jndi-name>
</properties>
</channel-definition>

  1. To configure data service destinations that do not use transactions with NIO based endpoints, set <use-transactions>false</use-transactions> for the data service destination in the /WEB-INF/flex/data-management-config.xml file.
  1. Create a WAR file from the expanded directory structure. For example: jar -cvf lcds.war *# From the WebSphere Administrator, define a WorkManager for use by your application. From the admin, choose Resources > Asynchronous Beans > Work managers. By default, the DefaultWorkManager is available at the wm/default jndi-name. Also, you can add a separate WorkManager for your application.
  2. Deploy the WAR file. During deployment, map the WorkManager resource-ref to an actual JNDI name for your WorkManager. For the DefaultWorkManager, wm/MessagingWorkManager (name used by your web.xml) maps to wm/default (the JNDI name of the actual server resource).
  3. (Optional) To enable custom authentication, open the WebSphere Administrator and configure a custom user registry using the files under [install_root]resources/security/websphere/ as usersFile and groupsFile custom properties.

Running the monitoring application, ds-console.war, on WebSphere with administrative security

  1. Uncomment the <security> section under the RuntimeManagement destination in the services-config.xml file for the ds-console web application. The file contains comments instructing users to do this when running on WebSphere with administrative security enabled.
  2. Uncomment the <security-constraint> section under <security> in the services-config.xml file for the ds-console web application. The file has comments instructing users to do this when running on WebSphere with administrative security enabled.
  3. Make sure that you use the WebSphereLoginCommand.
  4. Create a WAS User Group called console_administrator and add any users who are allowed to use this application to this group. These users must also have at least one role that allows them to access MBeans under WebSphere security.

JBoss

JBoss web application deployment

You can avoid this issue in JBoss 5.1.x by copying the hibernate-validator.jar that ships with JBoss in the {jboss.root}}/common/lib directory to the WEB-INF/lib directory of your Data Services webapp so that it is loaded by the same classloader as the hibernate jars that ship with Data Services.

In JBoss 5.0.x you also need to use a jboss-classloader.xml in your web application's WEB-INF directory to tell JBoss to load jars from the web application first. See your JBoss documentation on classloading for instructions. 

JBoss 4 authentication

(Optional) This configuration provides custom authentication against the current JBoss realm. Usually, the default location for this authentication stores user information in jboss_root/server/default/conf/users.properties and roles information in jboss_root/server/default/conf/roles.properties. For more information on realms, see the JBoss documentation. For more information on LiveCycle Data Services custom authentication, see the LiveCycle Data Services documentation and information in the install_root/resources/security directory.

  1. Copy the flex-tomcat-common.jar and flex-tomcat-server.jar files from the install_root/resources/security/tomcat folder to the jboss_root/server/default/lib folder.
  2. Add the TomcatValve to the context.xml in the jboss_root/server/default\deploy/jboss-web.deployer folder:
    <Valve className="flex.messaging.security.TomcatValve"/>
  3. Add users and roles to the users.properties and roles.properties files in jboss under jboss_root/server/default/conf folder.
  4. Restart JBoss.

You will now be authenticated against the current JBoss realm.

JBoss 5 authentication

This configuration provides custom authentication against the current JBoss realm:

  1. Copy the flex-tomcat-common.jar and flex-tomcat-server.jar files from the install_root/resources/security/tomcat folder to the jboss_root/server/default/lib folder.
  2. Add the TomcatValve to the context.xml under \server\default\deploy\jboss-web.sar:
    <Valve className="flex.messaging.security.TomcatValve"/>
  3. Create a tomcat-users.xml file in the jboss_root/server/default/conf directory. The following example shows a basic tomcat-users.xml file:
    <?xml version='1.0' encoding='utf-8'?>
    <tomcat-users>
    <role rolename="tomcat"/>
    <role rolename="role1"/>
    <user username="tomcat" password="tomcat" roles="tomcat"/>
    <user username="both" password="tomcat" roles="tomcat,role1"/>
    <user username="role1" password="tomcat" roles="role1"/>
    </tomcat-users>
  4. Replace the current security realm in the server.xml file under \server\default\deploy\jboss-web.sar with the following:
    <Realm className="org.apache.catalina.realm.MemoryRealm" pathname="../server/default/conf/tomcat-users.xml"/>
  5. Restart JBoss.

SAP NetWeaver

SAP NetWeaver requires that Data Services and Hibernate be deployed in Enterprise Application Archive (EAR) files. To deploy Data Services on NetWeaver, perform the following steps:

  1. Make sure the following three files are available for your Hibernate EAR file:

    <?xml version="1.0" encoding="UTF-8"?>
    <application-j2ee-engine xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="application-j2ee-engine.xsd">
    </application-j2ee-engine>

    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE application-service SYSTEM "application-service.dtd" >
    <application-service>
    </application-service>

  2. <SDA>
    <SoftwareType>J2EE</SoftwareType>
    <engine-deployment-descriptor version="2.0">
    <substitution-variable>
    <variable-name>com.sap.dc_name</variable-name>
    </substitution-variable>
    <substitution-variable>
    <variable-name>com.sap.dc_vendor</variable-name>
    </substitution-variable>
    <substitution-variable>
    <variable-name>com.sap.sld.GatewayHost</variable-name>
    </substitution-variable>
    <substitution-variable>
    <variable-name>com.sap.sld.GatewayService</variable-name>
    </substitution-variable>
    </engine-deployment-descriptor>
    </SDA>

  3. Package Hibernate in an EAR file. For more information see the SAP Netweaver documentation. Use the JAR files in the WEB-INF/lib directory of the dataservices.war file. The directory structure of the EAR file should look like this:

ds-sap-connector-hibernate.ear
|--lib
|--antlr-2.7.6.jar
|--commons-collections-3.1.jar
|--dom4j-1.6.1.jar
|--hibernate-3.6.6.jar
|--hibernate-jpa-2.0-api-1.0.1.Final.jar
|--javassist-3.15.GA.jar
|--slf4j-api-1.6.1.jar
|--META-INF
|--MANIFEST.MF
|--SAP_MANIFEST.MF
|--sda-dd.xml
|--application-j2ee-engine.xml
|--application-service.xml

  1. Add a reference from Data Services to Hibernate by adding the following code to theapplication-j2ee-engine.xml file:

<reference
reference-type="hard">
<reference-target
provider-name="com.adobe"
target-type="application">LiveCycleDataServicesHibernate</reference-target>
</reference>

  1. Create an Data Services EAR file that contains the dataservices.war file, along with the files required by SAP in the ear_root/META-INF folder.
  2. Update the NeverCompressed property of the HTTP Provider Service, to include *.swf, application/x-shockwave-flash, application/xml and application/x-amf.
  3. Deploy both EAR files to SAP NetWeaver.

 

Running Data Services from a compressed WAR

  1. Expand a Data Services WAR file using software such as WinZip or the JAR utility.
  2. Create your application, including SWF files, ActionScript files, configuration settings, and HTML files.
  3. Create a compressed WAR file from the expanded web application structure.
  4. Deploy the compressed WAR file.Note: Many samples applications in dataservices-samples.war file do not function within a compressed web application. Therefore, it is advised that you deploy the dataservices-samples web application as an expanded directory structure. If you uncompress a WAR file into a subdirectory that you create, that subdirectory must match the name of the prefix of the WAR file. That directory is also the context root of the web application. To use the model-driven development features, you must deploy the web applications as expanded directories rather than WAR files; For production, you can package web applications in compressed WAR files.

WebLogic

When running Data Services from a compressed WAR in WebLogic 11, in order to deploy or persist models you must set the model-persistence-directory property in the services-config.xml file with a fully qualified path. For example:

<!--
The Model Deployment Service deploys data models on server startup.
The persistence class can be configured if needed.
The default FilePersistence implementation can be configured with an alternative storage directory.
By default the /WEB-INF/datamodel directory in the web application is used.
Make sure to use a full directory path.
-->
<service id="model-deploy-service">
<!-- Generally you do not need to override the defaults -->
<!--
<properties>
<model-persistence-class>fiber.data.services.FilePersistence</model-persistence-class>
<model-persistence-directory>/path/to/model/directory</model-persistence-directory>
</properties>
-->
</service>

Installing the Edge Server

The Edge Server is a standard Data Services server specially configured and deployed in an organization’s demilitarized zone (DMZ), which is the subnetwork that contains and exposes an organization's external services to the Internet. The installation process for the Edge Server is identical to the installation process for a Data Services server in the application tier. The only difference is that the Edge Server is installed in the DMZ and configured to use a gateway service that communicates with a gateway endpoint on the Data Services server in the application tier.

Setting up the Data Services SAP Connector

Install SAP JCo Libraries

You can download the SAP Java Connector from the SAP Service Marketplace. You must make sure that the JCo libraries are in the classpath of your Data Services application. For example, on Tomcat, you can place the JCo libraries in the Tomcat sharelib folder.

Configure the SAP Connector Service

Use the services-config.xml file of the Data Services web application to configure the service that connects to the SAP server. The file contains two SapConnectorInitializationService elements that you use to configure the service. Both elements are commented out by default.

<!-- Default SAP Connector service.
Note: SAP Connector service must come before ModelDeploymentService in the config. -->
<service class="com.adobe.livecycle.sap.connector.SapConnectorInitializationService" id="sap-connector-service"/>

<!-- SAP Connector service with JCoSessionReferenceProvider. Use only one of the SapConnectorInitializationService service configurations.
If using this configuration, all SAP applications must use "PerSession" or "PerClient" authentication style. "None" style will result in a runtime exception.
Note: SAP Connector service must come before ModelDeploymentService in the config. -->
<service class="com.adobe.livecycle.sap.connector.SapConnectorInitializationService" id="sap-connector-service">
<properties>
<sap-session-provider>com.adobe.livecycle.sap.connector.JCoSessionReferenceProviderImpl</sap-session-provider>
</properties>
</service>

To enable the connector service, check the element comment and uncomment the appropriate service element.

Configure SAP technical user connection properties

The SAP server connection requires connection information, such as authentication credentials and connection pool setting.

Connection properties are stored in a text file in the WEB-INF/datasource/sap directory. The file extension must be .jcoDestination. Each line in the text file is a property-value pair with the following properties:

Using encrypted user credentials maximizes security. When using plain-text credentials as described here, use an SAP account that has minimum authorization for using the meta-data repository. This strategy lowers the security risk. For more information, see the SAP documentation or contact your SAP administrator.

A sample configuration file named sample-sap.jcoDestination is provided in the WEB-INF/datasource/sap directory. This file includes the following property-value pairs:

jco.client.lang=en
jco.destination.peak_limit=10
jco.client.client=001
jco.client.passwd=changeme
jco.client.user=sapuser
jco.client.sysnr=00
jco.destination.pool_capacity=2
jco.client.ashost=fully.qualified.server.name

Spring integration

You can integrate Data Services with Spring. The Data Services installation includes two Spring-enabled web applications:

For more information on Spring integration, see Using LiveCycle Data Services.

Building applications

Once you have installed Data Services, see "Getting Started with Data Services" in Using LiveCycle Data Services for JEE for a quick introduction to features and practical information about building and deploying applications.


Installing Data Services for JEE, Version 4.6 Prerelease-- 12/05/2011 9:58 AM