Workflow Ingester Batch Process Technical Specification

1 Technical Description

Create a batch step job that can read in Kuali Workflow XML documents and feed them to the ingester. This tool will be used primarily by the systems and conversion teams to automate the creation of new environments. See XML_Ingestion_Batch_Job_Technical_Spec.doc

2 Requirements

2.1 Functional Requirements

• input will be a comma-delimited list of full path names pointing at KEW XML files.
• The batch step will read in those files and feed them to theXML IngesterService
  • Files will be read from

    ${staging.directory}/ingester

    .
• Log file should be created (and saved to standard logs directory) if ingestion fails on any doc. Log file should list which document failed and display stack trace, if available and error thrown by XMLIngesterService
• This step should be placed in the standard community package structure as it will be donated back to the community immediately to be used by all implementing schools. Make sure to use community standards for coding as well as comments (copyright, etc)

2.2 External Interface Requirements

edu.iu.uis.eden.KEWServiceLocator
edu.iu.uis.eden.batch.CompositeXmlDocCollection;
edu.iu.uis.eden.batch.FileXmlDocCollection
edu.iu.uis.eden.batch.XmlDoc
edu.iu.uis.eden.batch.XmlDocCollection
edu.iu.uis.eden.util.Utilities
edu.iu.uis.eden.web.UserLoginFilter
org.apache.log4j.Logger

2.3 Performance Requirements

None.

2.4 Security Requirements

None.

2.5 User Documentation

This is it.

2.6 Software Quality Factors

None.

2.7 Other Requirements

None.

3 Details

Some of this information taken from KFS Batch 3 Documentation

3.1 Components

Pieces used to create the functionality.

• Workflow Ingester from KEW
• Quartz from Spring
• Step Written in Java

3.2 Instructions to Creating XML Ingester Job

1. Create Java Step implementation in org.kuali.kfs.sys.batch called WorkflowXmlIngestionStep
2. Add workflowXmlIngestionJob to Spring Configuration to work/src/org/kuali/kfs/sys/spring-sys.xml

   <bean id="workflowXmlIngestionJob" parent="scheduledJobDescriptor">
   ...
   </bean>

   1. Add the step created from instructions in WorkflowXmlIngestionStep

      <bean id="workflowXmlIngestionJob" parent="scheduledJobDescriptor">
          <property name="steps">
              <list>
                  <ref bean="workflowXmlIngestionStep" />
              </list>
          <property>
      </bean>

3. Add trigger for the workflowXmlIngestionJob

   <bean id="workflowXmlIngestionTrigger" parent="simpleTrigger">
       <property name="jobName" value="workflowXmlIngestionJob" />
   </bean>

   1. Configure for Delay of 300000 milliseconds

      <property name="startDelay" value="300000" />
       <property name="repeatCount" value="0" />

Jira Tasks

KITT-103@Jira