<fuego : publish>

Description

This task publishes and deploys a complete BPM project.

Use nested elements include and exclude to include/exclude particular processes within a project from publication.

It can handle the mapping of role/variables/resources, by either:

Example:

  ...
  <!-- Open a session to the Fuego directory -->
    <fuego:session passportref="fuego.passport">

      <!-- Publish processes -->
      <fuego:publish fpr="${fuego.project}"
                     deploy="true"
                     engine="${fuego.engine}">

          <!-- Role mappings -->
          <fuego:rolemap abstract="Approver" real="CFO"/>
          <fuego:rolemap abstract="Requester" real="Consultant"/>

          <!-- Deploy info -->
          <fuego:deployinfo engine="${fuego.engine2}"
                    ou="${fuego.ou2}" processname="${fuego.processName}"
                    variation="${fuego.processVariation}"/>

      </fuego:publish>
  </fuego:session>
  ...
 

Parameters

Attribute Description Type Required?
viewsgenerationtype Choose which type of views will be generated for the deployed processes. String ["unified_inbox", "by_process", "by_process_and_activity"] No Defaults to "unified_inbox" type
fpr Fuego Project folder to use for publishing/deploying. File Yes Unless <projects> nested element is used.
haltonerror Whether to stop the ant build process if an error occurs during the execution of this task. boolean No Defaults to false
deploy Whether to deploy the process after publishing boolean No Defaults to false
archiveattachments Enable archive attachments for all the processes into the project. Boolean No Defaults to false
importcustomviews Import custom portal Views and Presentations from the project (defined with Studio's PortalAdmin), taking into account the roles and variables mappings. boolean No Defaults to false
remarks Optional commentary to add to the processes publication. String No
ou Organizational Unit where processes will be deployed. Only meaninful when deploy is true String No
keepgeneratedfiles Do not remove the .java and .class files generated during publication. It overrides the studio preference. IMPORTANT: This flag has currently no effect. It is being kept for backwards compatibility only. boolean No Ignored since version 6.0.
automaproles Automatically map abstract roles to real ones with the same name. Useful when using the importdata option. boolean No Defaults to false
archive Enable archive for all the processes into the project. Boolean No Defaults to false
compatibilityreportfilename Sets the name of the XML file wich is going to contain the compatibility information. If no value is provided to this attribute, then the output should only be in stdout. String No Defaults to false
automapbuspars Automatically map business parameter variable names (as defined in the project design) to an business parameter variable id with the same name (as defined in the Fuego Enterprise directory). Useful when using the importdata option. boolean No Defaults to false
mode Define how to handle project versioning.
  • new-major: forces a major release, even if the project is compatible with the currently deployed version. This increments the major version number by one, reseting the minor version and revision numbers to zero (i.e.: 1.4.3 -> 2.0.0).
  • keep: if the project is compatible with the previously published version, then it creates a new revision, keeping the same major and minor version numbers (i.e.: 1.4.3 -> 1.4.4). This effectively replaces the current version of the code with the new revision for all active instances. If the project is not compatible with the previous version, then it will be published as a new version, incrementing the minor version number by one, and reseting the revision to zero (i.e.: 1.4.3 -> 1.5.0).
  • new: ignored. Reserved for future use.
String ["new-major", "new", "keep"] No Defaults to keep
checkcompatibilityonly Stops the Ant Task execution after displaying the projects version information Just shows the version information and does not publish/deploy the project. boolean No Defaults to false
notifyengines Whether to notify Engines about new and modified processes. boolean No Defaults to true
importdata Whether to import data from the project, as defined in Fuego Studio. This includes importing:
  • Holiday and Calendar rules
  • Organizational Units
  • Roles
  • Resource configurations
  • External Variables
boolean No Defaults to false
archivenotes Enable archive notes for all the processes into the project. Boolean No Defaults to false
automapconfigs Automatically map External Resources configurations (as defined in the project design) to real Configurations with the same name (as defined in the Fuego Enterprise directory). Useful when using the importdata option. boolean No Defaults to false
automapvars Automatically map external variable names (as defined in the project design) to an external variable id with the same name (as defined in the Fuego Enterprise directory). Useful when using the importdata option. boolean No Defaults to false
abortifincompatible Stops the Ant Task execution when the new version of the project is incompatible with the previous published version of the project. boolean No Defaults to false
loadpublicationinfo Use the publication information defined in the projectname.fpr/publication.xml file. Including:
  • Role mappings
  • Resource configuration mappings
  • External Variable mappings
boolean No Defaults to false
engine Name of the Engine for deployment String Yes when deploy is true

Parameters accepted as nested elements

<varmap>

Represents a mapping of an abstract External (or Business) Variable name (as defined in the project design) to a real External Variable (as defined in the Fuego Enterprise directory)
Attribute Description Type Required
externalid Id of real external variable, as configured in the Enterprise directory. String Yes
name Id of abstract external variable as defined in the process design String ?

<include>

Declares a particular process to be included in the publication/deployment. If no <include> element is used, all the process in the project will be included.
Attribute Description Type Required
name The name of the process to include. String Yes
variation The variation of the process to include. String No If not specified "Default" is assumed.

<busparmap>

Represents a mapping of an abstract Business Parameter (as defined in the project design) to real Business Parameter (as defined in the Directory).
Attribute Description Type Required
abstract Id of abstract business parameter String Yes
real Id of Real business parameter String No If omitted, the same id specified in abstract role will be used (Useful when using the importdata option). See automaprole.

<exclude>

Declares a particular process to be excluded from the publication/deployment.
Attribute Description Type Required
name The name of the process to exclude. String Yes
variation The variation of the process to exclude. String No If not specified "Default" is assumed.

<projects> (Of type FileSet )

Attribute Description Type Required
refid Reference ?
file File ?
dir File ?
defaultexcludes boolean ?
followsymlinks boolean ?
casesensitive boolean ?
excludes String ?
includesfile File ?
excludesfile File ?
includes String ?

<rolemap>

Represents a mapping of an abstract Role (as defined in the project design) to real Role (as defined in the Directory)
Attribute Description Type Required
abstract Id of abstract role String Yes
real Id of Real role String No If omitted, the same id specified in abstract role will be used (Useful when using the importdata option). See automaprole.

<confmap>

Represents a mapping of an abstract Resource Configuration name (as defined in the project design) to a real Real Configuration (as defined in the Directory)
Attribute Description Type Required
local String ?
real String ?

<deployinfo>

Attribute Description Type Required
variation String ?
archive Enable archive for the process. Boolean No Defaults to false
ou String ?
engine String ?
archiveattachments Enable archive attachments for the process. Boolean No Defaults to false
processname String ?
archivenotes Enable archive notes for the process. Boolean No Defaults to false