How to generate the process documentation?
The system documentation (http://documentation.bonitasoft.com/?page=generate-process-documentation...) refer a "Menu bar > Process" that I should access to Generate Documentation, but my Bonita BPM Studio does not have a Process Menu or Submenu.
Have you ever been succeeded in generating a model/process documentation? How? Where?
Thanks.
Luciano Gomes
Ok, but the documentation does not explain that restriction. :(
I just know Community and Subscription versions. I had never heard about Performance, Efficiency and Teamwork versions. The documentation does not tell about them as well.
Finally, I will try the solution you pointed me. After, if it work, I come back here and mark as resolved.
Thanks a lot.
You've missed the great big bit at the front that says:
Generate process documentation
Note: For Bonita BPM Performance, Efficiency, and Teamwork editions only.
So if using community this is not available. You could write your own via APIs using DesignProcessDefinition though.
regards
Seán
PS: While you may not like the answer, it gives a possible solution, please mark as resolved.
Comments
The documentation does explain the distinction here :
Editions
Bonita BPM is provided in four different editions: Community, Teamwork, Efficiency, Performance.
Admittedly it's not clear but it is there...also from the sales point of view there is a section on the differences here on the main Bonitasoft site.
To help you along...here is some code I provided for another issue:
import java.util.logging.Logger;
import java.lang.StringBuilder;
import org.bonitasoft.engine.api.ProcessAPI
import org.bonitasoft.engine.bpm.businessdata.BusinessDataDefinition
import org.bonitasoft.engine.bpm.connector.ConnectorDefinition
import org.bonitasoft.engine.bpm.data.DataDefinition
import org.bonitasoft.engine.bpm.document.DocumentDefinition
import org.bonitasoft.engine.bpm.flownode.ActivityDefinition
import org.bonitasoft.engine.bpm.flownode.EndEventDefinition
import org.bonitasoft.engine.bpm.flownode.FlowElementContainerDefinition
import org.bonitasoft.engine.bpm.flownode.GatewayDefinition
import org.bonitasoft.engine.bpm.flownode.IntermediateCatchEventDefinition
import org.bonitasoft.engine.bpm.flownode.IntermediateThrowEventDefinition
import org.bonitasoft.engine.bpm.flownode.StartEventDefinition
import org.bonitasoft.engine.bpm.flownode.TransitionDefinition
import org.bonitasoft.engine.bpm.process.DesignProcessDefinition
import org.bonitasoft.engine.bpm.process.ProcessDeploymentInfo
import org.bonitasoft.engine.bpm.process.ProcessDeploymentInfoCriterion;
import org.bonitasoft.engine.bpm.process.ProcessDeploymentInfoSearchDescriptor;
import org.bonitasoft.engine.bpm.process.ProcessInstance;
import org.bonitasoft.engine.bpm.process.ProcessInstanceSearchDescriptor;
import org.bonitasoft.engine.bpm.process.ProcessInstanceState;
int dI = 0;
boolean debug = true;
StringBuilder logWrite = new StringBuilder();
StringBuilder flowChartJS1 = new StringBuilder();
Logger logger = Logger.getLogger("org.bonitasoft");
ProcessAPI processAPI = apiAccessor.getProcessAPI();
//set the name of the routine
String processName =processAPI.getProcessInstance(processInstanceId).getName();
logWrite.append("\n\nProcess Name: "+ processName);
logWrite.append("\nprocessInstanceId: "+ processInstanceId.toString());
logWrite.append("\nprocessDefinitionId: "+ processDefinitionId.toString());
logWrite.append("\nactivityInstanceId: "+ activityInstanceId.toString());
logWrite.append("\ntaskAssigneeId: "+ taskAssigneeId.toString());
logWrite.append("\nrootProcessInstanceId: "+ rootProcessInstanceId.toString());
logWrite.append("\n\t" + dI++ + " Trace Start");
//TODO - Code goes in here - START
DesignProcessDefinition resultDesignProcessDefinition = processAPI.getDesignProcessDefinition(processDefinitionId);
FlowElementContainerDefinition flowElementContainer = resultDesignProcessDefinition.getFlowElementContainer();
//Start
List<StartEventDefinition> startEvents = flowElementContainer.getStartEvents();
for(StartEventDefinition q : startEvents){
flowChartJS1.append(q.getId().toString()+"=>start: "+q.getName().toString()+"\n");
//logWrite.append("\n\t\t" + dI++ + " startEvents = " + q.toString());
logWrite.append("\n\t\t" + dI++ + " startEvents Name = " + q.getName().toString());
logWrite.append("\n\t\t" + dI++ + " startEvents Id = " + q.getId().toString());
logWrite.append("\n\t\t" + dI++ + " startEvents IncomingTransitions= " + String.valueOf(q.getIncomingTransitions()));
logWrite.append("\n\t\t" + dI++ + " startEvents OutgoingTransitions= " + String.valueOf(q.getOutgoingTransitions()));
logWrite.append("\n");
}
//flowchart.js
//End
List<EndEventDefinition> endEvents = flowElementContainer.getEndEvents();
logWrite.append("\n\n\t" + dI++ + " 7 endEvents");
for(EndEventDefinition q : endEvents){
flowChartJS1.append(q.getId().toString()+"=>end: "+q.getName().toString()+"\n");
// logWrite.append("\n\t\t" + dI++ + " endEvents = " + q.toString());
logWrite.append("\n\t\t" + dI++ + " endEvents Name = " + q.getName().toString());
logWrite.append("\n\t\t" + dI++ + " endEvents Id = " + q.getId().toString());
logWrite.append("\n\t\t" + dI++ + " endEvents IncomingTransitions= " + String.valueOf(q.getIncomingTransitions()));
logWrite.append("\n\t\t" + dI++ + " endEvents OutgoingTransitions= " + String.valueOf(q.getOutgoingTransitions()));
logWrite.append("\n");
}
//Activities
List<ActivityDefinition> processActivities = flowElementContainer.getActivities();
for(ActivityDefinition q : processActivities){
flowChartJS1.append(q.getId().toString()+"=>operation: "+q.getName().toString()+"\n");
// logWrite.append("\n\t\t" + dI++ + " processActivities = " + q.toString());
logWrite.append("\n\t\t" + dI++ + " processActivities Name = " + q.getName().toString());
logWrite.append("\n\t\t" + dI++ + " processActivities Id = " + q.getId().toString());
logWrite.append("\n\t\t" + dI++ + " processActivities Condition = " + q.getDefaultTransition().toString());// .getCondition().toString());
logWrite.append("\n\t\t" + dI++ + " processActivities IncomingTransitions= " + q.getIncomingTransitions().toString());
logWrite.append("\n\t\t" + dI++ + " processActivities LoopCharacteristics= " + q.getLoopCharacteristics().toString());
logWrite.append("\n\t\t" + dI++ + " processActivities OutgoingTransitions= " + q.getOutgoingTransitions().toString());
logWrite.append("\n\t\t" + dI++ + " processActivities Operations = " + q.getOperations().toString());
logWrite.append("\n");
}
//flowchart.js
//Conditions
List<GatewayDefinition> gatewaysList = flowElementContainer.getGatewaysList();
for(GatewayDefinition q : gatewaysList){
flowChartJS1.append(q.getId().toString()+"=>condition: "+q.getName().toString()+"\n");
//logWrite.append("\n\t\t" + dI++ + " gatewaysList = " + q.toString());
logWrite.append("\n\t\t" + dI++ + " gatewaysList Name = " + q.getName().toString());
logWrite.append("\n\t\t" + dI++ + " gatewaysList Id = " + q.getId().toString());
logWrite.append("\n\t\t" + dI++ + " gatewaysList GatewayType = " + q.getGatewayType().toString());
logWrite.append("\n\t\t" + dI++ + " gatewaysList IncomingTransitions = " + q.getIncomingTransitions().toString());
logWrite.append("\n\t\t" + dI++ + " gatewaysList getOutgoingTransitions= " + q.getOutgoingTransitions().toString());
logWrite.append("\n");
}
//flowchart.js
//Transitions
Set<TransitionDefinition> transitions = flowElementContainer.getTransitions();
for(TransitionDefinition q : transitions){
flowChartJS1.append(q.getSource().toString()+"->"+q.getTarget().toString()+"\n");
//logWrite.append("\n\t\t" + dI++ + " transitions = " + q.toString());
logWrite.append("\n\t\t" + dI++ + " transitions Source = " + q.getSource().toString());
logWrite.append("\n\t\t" + dI++ + " transitions SourceFlowNode = " + q.getSourceFlowNode().getName().toString());
logWrite.append("\n\t\t" + dI++ + " transitions Target = " + q.getTarget().toString());
logWrite.append("\n\t\t" + dI++ + " transitions TargetFlowNode = " + q.getTargetFlowNode().getName().toString());
logWrite.append("\n\t\t" + dI++ + " transitions Condition = " + q.getCondition().toString());
logWrite.append("\n");
}
//TODO - Code goes in here - END
logWrite.append("\n\t" + dI++ + " Trace End");
logWrite.append("\n\n");
if(debug){logger.severe(logWrite.toString())}
logger.severe("\n\n"+flowChartJS1.toString()+"\n\n");
To use it:
There you will see the Start and End, Tasks, Gateways and Transitions
Please refer the the Javadoc for other capabilities of the DesignProcessDefinition API
regards
Seán