Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Stardust/Knowledge Base/Java API"
< Stardust | Knowledge Base
Line 1: | Line 1: | ||
+ | __NOTOC__ | ||
<pre>NOTE to authors: Please make sure to specify the version on which the example was tested. | <pre>NOTE to authors: Please make sure to specify the version on which the example was tested. | ||
All version numbers < 7.0 refer to the Infinity Process Platform (IPP) | All version numbers < 7.0 refer to the Infinity Process Platform (IPP) | ||
</pre> | </pre> | ||
− | <br>NOTE: The ServiceFactory caches the authenticated Stardust services for the user. For use in a production environment it is important that the clients cache the ServiceFactory per user. Not caching the ServiceFactory means that a new login will be performed for every interaction with the engine. | + | <br>NOTE: The ServiceFactory caches the authenticated Stardust services for the user. For use in a production environment it is important that the clients cache the ServiceFactory per user. Not caching the ServiceFactory means that a new login will be performed for every interaction with the engine. <br> |
+ | |||
+ | == Process and Activity Instance Lifecycle == | ||
+ | |||
+ | *[[STP/Stardust/KnowledgeBase/API/JavaAPICookbook/Stardust Workflow Service in Action|Stardust Workflow Service in Action]] | ||
+ | **Starting a Process | ||
+ | **Activating and completing an Activity | ||
+ | **Aborting an Activity | ||
+ | **Delegating an Activity | ||
+ | **Suspending an Activity | ||
+ | **Fetching the User Work List | ||
+ | **Submitting Process Data<br> | ||
+ | |||
+ | *[[STP/Stardust/KnowledgeBase/API/ExamplesofAPIUsage/StartProcess|Start a process]] | ||
+ | *[[STP/Stardust/KnowledgeBase/API/ExamplesofAPIUsage/CompleteAnActivity|Complete an Activity]] | ||
+ | *[[STP/Stardust/KnowledgeBase/API/ExamplesofAPIUsage/AttachADocument|Attaching a document to a process instance]]<br> | ||
+ | *[[STP/Stardust/KnowledgeBase/API/ExamplesofAPIUsage/Initialization|Initialization]] | ||
+ | *[[STP/Stardust/KnowledgeBase/API/JavaAPICookbook/EventHandling|Event Handling]] - binding and unbinding event handler vai the API<br> | ||
<br> | <br> | ||
+ | |||
+ | == Queries == | ||
*[[STP/Stardust/KnowledgeBase/API/JavaAPICookbook/QueryingWorklists|Querying Worklists]] - querying different user, user group, role or organization worklists based on different predicates | *[[STP/Stardust/KnowledgeBase/API/JavaAPICookbook/QueryingWorklists|Querying Worklists]] - querying different user, user group, role or organization worklists based on different predicates | ||
*[[STP/Stardust/KnowledgeBase/API/JavaAPICookbook/Querying Workflow and Runtime|Querying Worklow and Runtime Information]] - querying e.g. model information, users having a certain role, the logged in user,... | *[[STP/Stardust/KnowledgeBase/API/JavaAPICookbook/Querying Workflow and Runtime|Querying Worklow and Runtime Information]] - querying e.g. model information, users having a certain role, the logged in user,... | ||
− | |||
− | |||
*[[STP/Stardust/KnowledgeBase/API/JavaAPICookbook/Querying Activity Instance List|Querying Activity Instance List ]] - querying e.g. Activity Instance List, Activity Instance having a certain state,... | *[[STP/Stardust/KnowledgeBase/API/JavaAPICookbook/Querying Activity Instance List|Querying Activity Instance List ]] - querying e.g. Activity Instance List, Activity Instance having a certain state,... | ||
+ | |||
+ | <br> | ||
+ | |||
+ | == Organizational Structure & Authorizations == | ||
+ | |||
+ | *[[STP/Stardust/KnowledgeBase/API/ExamplesofAPIUsage/GeneratingRoleBasedAPI|Generating Role/Grant-based Stardust API Queries]]<br> | ||
+ | *[[STP/Stardust/KnowledgeBase/API/ExamplesofAPIUsage/CreateDepartments|Creating Departments Programmatically]]<br> | ||
+ | *Process instances | ||
+ | *Status of a Process Instance | ||
+ | *History of a ProcessInstance | ||
+ | *Listing Data Mappings of an Activity<br> | ||
+ | |||
+ | <br> | ||
+ | |||
+ | == Document Management == | ||
+ | |||
+ | *[[STP/Stardust/KnowledgeBase/API/DMSJavaAPIExample|DMS Java API Examples]] | ||
+ | |||
+ | <br> | ||
+ | |||
+ | == Other == | ||
+ | |||
+ | *[[STP/Stardust/KnowledgeBase/API/ExamplesofAPIUsage/SupportCaseJavaAPI|Executing the Support Case Example using the Stardust Java API]] | ||
+ | *[[STP/Stardust/KnowledgeBase/API/ExamplesofAPIUsage/CompleteAPIExample|Complete Stardust API Example]] | ||
<br> | <br> |
Revision as of 00:43, 29 February 2012
NOTE to authors: Please make sure to specify the version on which the example was tested. All version numbers < 7.0 refer to the Infinity Process Platform (IPP)
NOTE: The ServiceFactory caches the authenticated Stardust services for the user. For use in a production environment it is important that the clients cache the ServiceFactory per user. Not caching the ServiceFactory means that a new login will be performed for every interaction with the engine.
Process and Activity Instance Lifecycle
- Stardust Workflow Service in Action
- Starting a Process
- Activating and completing an Activity
- Aborting an Activity
- Delegating an Activity
- Suspending an Activity
- Fetching the User Work List
- Submitting Process Data
- Start a process
- Complete an Activity
- Attaching a document to a process instance
- Initialization
- Event Handling - binding and unbinding event handler vai the API
Queries
- Querying Worklists - querying different user, user group, role or organization worklists based on different predicates
- Querying Worklow and Runtime Information - querying e.g. model information, users having a certain role, the logged in user,...
- Querying Activity Instance List - querying e.g. Activity Instance List, Activity Instance having a certain state,...
Organizational Structure & Authorizations
- Generating Role/Grant-based Stardust API Queries
- Creating Departments Programmatically
- Process instances
- Status of a Process Instance
- History of a ProcessInstance
- Listing Data Mappings of an Activity
Document Management
Other