API:EPrints/Workflow

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects

---

API: Core API

Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki

NAME

EPrints::Workflow - Models the submission process used by an repository.

User Comments

DESCRIPTION

The workflow class handles loading the workflow configuration for a single repository.

User Comments

WORKFLOW FORMAT

User Comments

component

Parents: [[API:EPrints/Workflow#stage|]]

Children: [[API:EPrints/Workflow#field|]]

Attributes: type

 <component type="Field::Multi">
   <field ref="title" />
   <field ref="abstract" />
 </component>
 

User Comments

field

Parents: [[API:EPrints/Workflow#component|]]

Children: [[API:EPrints/Workflow#sub_field|]]

Attributes: ref

 <field ref="title" input_cols="40" />
 

field includes a metafield in the workflow. Any property can be set for the field by supplying it as an attribute.

User Comments

flow

Parents: [[API:EPrints/Workflow#workflow|]]

Children: [[API:EPrints/Workflow#stage|]]

 <flow>
   <stage ref="files" />
   <stage ref="details" />
 </flow>
 

User Comments

stage

Parents: [[API:EPrints/Workflow#workflow|]], [[API:EPrints/Workflow#flow|]]

Children: [[API:EPrints/Workflow#component|]]

Attributes: ref, name

 <stage name="details">
   <component><field ref="title"/></component>
 </stage>
 

User Comments

sub_field

Parents: [[API:EPrints/Workflow#field|]]

sub_field allows properties to be set for sub-fields of EPrints::MetaField::Compound and sub-classed field types.

See [[API:EPrints/Workflow#field|]] for possible attributes.

User Comments

workflow

Children: [[API:EPrints/Workflow#flow|]], [[API:EPrints/Workflow#stage|]]

 <workflow xmlns="http://eprints.org/ep3/workflow">
   <flow>
     ...
   </flow>
   <stage name="files">
     ...
   </stage>
   <stage name="details">
     ...
   </stage>
 </workflow>
 

User Comments

METHODS

User Comments

new

$language = EPrints::Workflow->new( $session, $workflow_id, %params )

Create a new workflow object representing the specification given in the workflow.xml configuration

1. needs more config - about object etc.

User Comments

add_workflow_flow

$repository->add_workflow_flow( $workflowid, $id, $types, $stages )

Add a flow to the workflow which is applicable for the types in types and contains the stages in stages.

The $id is used to remove everything relating to this is from the workflow.

User Comments

COPYRIGHT

User Comments