ingester:ingest

Full name:

org.kuali.maven.plugins:ingester-maven-plugin:1.0.4-beta:ingest

Description:

Ingest workflow documents into Rice

Attributes:

  • Requires a Maven project to be executed.

Required Parameters

Name Type Since Description
jdbcPassword String - The database password for the specified username
jdbcUrl String - The jdbc connect url
jdbcUsername String - The database username
jdbcVendor String - The type of database (mysql, oracle, etc)
Default value is: mysql.
namespace String - Namespace for Rice
sourceDir File - The directory containing documents to ingest
Default value is: ${project.basedir}/src/main/resources.
workingDir File - The working directory where the documents to ingest are copied. The plugin loads them from here, and transitions them from the "pending" directory to either the "completed" or "problem" directories.
Default value is: ${project.build.directory}/ingester.

Optional Parameters

Name Type Since Description
excludes String[] - Exclusion patterns. By default, nothing is excluded.
includes String[] - Inclusion patterns. By default **/*.xml is included
jdbcDriver String - Jdbc driver to use. This is optional because a default driver for the specified jdbcVendor is usually the correct one to use. If a driver is provided here, it overrides the default.
propsKey String - System property key the plugin uses to locate an external properties file to load
Default value is: ingester.config.location.
propsLoc File - Location of the external properties file to load
Default value is: ${project.build.directory}/ingester/config/ingester.properties.

Parameter Details

excludes:

Exclusion patterns. By default, nothing is excluded.
  • Type: java.lang.String[]
  • Required: No

includes:

Inclusion patterns. By default **/*.xml is included
  • Type: java.lang.String[]
  • Required: No

jdbcDriver:

Jdbc driver to use. This is optional because a default driver for the specified jdbcVendor is usually the correct one to use. If a driver is provided here, it overrides the default.
  • Type: java.lang.String
  • Required: No
  • Expression: ${ingester.jdbcDriver}

jdbcPassword:

The database password for the specified username
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${ingester.jdbcPassword}

jdbcUrl:

The jdbc connect url
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${ingester.jdbcUrl}

jdbcUsername:

The database username
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${ingester.jdbcUsername}

jdbcVendor:

The type of database (mysql, oracle, etc)
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${ingester.jdbcVendor}
  • Default: mysql

namespace:

Namespace for Rice
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${ingester.namespace}

propsKey:

System property key the plugin uses to locate an external properties file to load
  • Type: java.lang.String
  • Required: No
  • Expression: ${ingester.propsKey}
  • Default: ingester.config.location

propsLoc:

Location of the external properties file to load
  • Type: java.io.File
  • Required: No
  • Expression: ${ingester.propsLoc}
  • Default: ${project.build.directory}/ingester/config/ingester.properties

sourceDir:

The directory containing documents to ingest
  • Type: java.io.File
  • Required: Yes
  • Expression: ${ingester.sourceDir}
  • Default: ${project.basedir}/src/main/resources

workingDir:

The working directory where the documents to ingest are copied. The plugin loads them from here, and transitions them from the "pending" directory to either the "completed" or "problem" directories.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${ingester.workingDir}
  • Default: ${project.build.directory}/ingester