Configuration

Configuration of a LiveCycle application / custom component

Configuration of a LiveCycle application / custom component

Maven command:

mvn livecycle:configure

Following are an example to configure a LiveCycle application and an example to configure a LiveCycle custom component.

Both follow the same pattern:

• make a configuration file
• refer to the wanted configuration file in your pom.xml
• use the configure goal of the plugin

We recommend you to use the standard Maven conventions for file locations, and as such we propose to put your configuration files in the '${basedir}/src/main/lc/' directory.

Configuration of a LiveCycle application (lca file)

First of is a configuration file where we specify the configuration parameters we want to see configured for our processes. In this example the configuration file is located at '${basedir}/src/main/lc/acc-config.xml'

<?xml version="1.0" encoding="UTF-8"?>
<config xmlns="http://www.ida-mediafoundry.be/livecycle/configuration" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	
	<service name="MyApplication/Processes/Utils/ErrorHandler" >
		<configuration>
			<property name="confEnvironment" value="ACCEPTANCE"/>
			<property name="confAdminAddress" value="acc@example.com"/>
		</configuration>
	</service>
	
	<service name="MyApplication/Processes/RenderLicence" >
		<configuration>
			<property name="confTargetURL" value="http://www.example.com/MyApplication/Processes/RenderLicence:1.1"/>
		</configuration>
	</service>
	
</config>

This configuration file is then referenced in the pom.xml file.

<?xml version="1.0" encoding="UTF-8"?>
<project
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

  <modelVersion>4.0.0</modelVersion>
  <groupId>be.idamediafoundry.sofa.livecycle.maven</groupId>
  <artifactId>lca-deployment-example</artifactId>
  <packaging>pom</packaging>
  <name>LCA deployment example</name>
  <version>1</version>
  
  <build>
    <plugins>
      <plugin>
        <groupId>be.idamediafoundry.sofa.livecycle</groupId>
        <artifactId>livecycle-maven-plugin</artifactId>
        <version>1.0</version>
        <configuration>
          <host>hostname</host>
          <port>8080</port>
          <protocol>SOAP</protocol>
          <username>administrator</username>
          <password>password</password>
          <configurationFile>${basedir}/src/main/lc/acc-config.xml</configurationFile>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>jboss</groupId>
            <artifactId>jbossall-client</artifactId>
            <version>4.2.2.GA</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

Use the //configure// goal of the plugin. Deploying your LiveCycle application and running the configuration after deployment amounts to:

mvn livecycle:deploy-lca livecycle:configure

Configuration of a LiveCycle custom component (dsc file)

First of is a configuration file where we specify the configuration parameters we want to see configured for our custom component. In this example the configuration file is located at '${basedir}/src/main/lc/acc-config.xml', and will set the server information to be used in the acceptance environment for our custom component.

<?xml version="1.0" encoding="UTF-8"?>
<config xmlns="http://www.ida-mediafoundry.be/livecycle/configuration" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  
  <service name="MyCustomComponent" >
    <configuration>
      <property name="remoteHost" value="hostname"/>
      <property name="remotePort" value="8099"/>
    </configuration>
  </service>
    
</config>

This configuration file is then referenced in the pom.xml file.

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

  <modelVersion>4.0.0</modelVersion>
  <groupId>be.idamediafoundry.sofa.livecycle.maven</groupId>
  <artifactId>dsc-deployment-example</artifactId>
  <version>1</version>
  <packaging>jar</packaging>
  <name>Custom Component deployment example</name>

  <build>
    <plugins>
      <plugin>
      <groupId>be.idamediafoundry.sofa.livecycle</groupId>
      <artifactId>livecycle-maven-plugin</artifactId>
      <version>1.0</version>
      <configuration>
        <host>hostname</host>
        <port>8080</port>
        <protocol>SOAP</protocol>
        <username>administrator</username>
        <password>password</password>
        <dscFile>${project.build.directory}/dsc.jar</dscFile>
        <configurationFile>${basedir}/src/main/lc/acc-config.xml</configurationFile>
      </configuration>
      </plugin>
    </plugins>
  </build>
  
</project>

Use the configure goal of the plugin. Deploying your LiveCycle custom component and running the configuration after deployment amounts to:

mvn livecycle:deploy-dsc livecycle:configure

Schema documentation

You can use your favourite tool to inspect the configuration.xsd schema, or refer to this Schema documentation for the livecycle-maven-plugin configuration.xsd