Table of Contents

Search

  1. Preface
  2. Welcome to Informatica Process Developer
  3. Using Guide Developer for the First Time
  4. Getting Started with Informatica Process Developer
  5. About Interfaces Service References and Local WSDL
  6. Planning Your BPEL Process
  7. Participants
  8. Implementing a BPMN Task or Event in BPEL
  9. Implementing a BPMN Gateway or Control Flow
  10. Using Variables
  11. Attachments
  12. Using Links
  13. Data Manipulation
  14. Compensation
  15. Correlation
  16. What is Correlation
  17. What is a Correlation Set
  18. Creating Message Properties and Property Aliases
  19. Adding a Correlation Set
  20. Deleting a Correlation Set
  21. Adding Correlations to an Activity
  22. Rules for Declaring and Using Correlation Sets
  23. Correlation Sets and Engine-Managed Correlation
  24. Event Handling
  25. Fault Handling
  26. Simulating and Debugging
  27. Deploying Your Processes
  28. BPEL Unit Testing
  29. Creating POJO and XQuery Custom Functions
  30. Custom Service Interactions
  31. Process Exception Management
  32. Creating Reports for Process Server and Central
  33. Business Event Processing
  34. Process Central Forms and Configuration
  35. Building a Process with a System Service
  36. Human Tasks
  37. BPEL Faults and Reports

2. Designer

2. Designer

Adding Documentation to a Process

Adding Documentation to a Process

You can add one or more documentation items to the process or to an activity. If desired for language support, add a language identifier. The source field is for application-specific reference.
Process Developer offers two ways to add annotations to a process: Comments and Documentation. You can add a <documentation> element to a BPEL process, activities, and links. For design-time, comments are useful because you can add tasks and to do items to them. For details, see
Adding Comments to a Process
.
You can add documentation to any element of the process, such as an activity, link, variable, or the process itself.
If you generate a process report, the documentation is very useful. For details, see
Generate Process Report
.
  1. Select an item from the Outline view or the Process Editor canvas. For example:
    • Select Process or a partner link, variable, or copy operation from the Outline view
    • Select an activity or link on the
      Process Editor
      canvas
  2. In the Properties view, do one of the following:
    • Type text directly into the Documentation tab.
    • In the All view, at the end of the Documentation row, click
      Dialog (..)
      . Complete the dialog as shown below.
To fill in the Documentation Details:
  1. Select
    New
    to open the
    Documentation Details
    dialog, as the example shows.
  2. Fill in the dialog as follows:
    • Documentation
      . Enter the content in your chosen format, such as plain text, HTML, or XHTML.
    • Language
      (optional). Type in the language identifier of the natural or formal language that the content is written in. Refer to the XML 1.0 specification for language identifier reference details.
    • Source
      (optional). This attribute indicates the source of application information, in the form of a URI. (The attribute is described in the XSD schema and is generally included with the documentation element.)
  3. Click
    OK
    , and select
    New
    to add additional documentation elements.
  4. In the Documentation entries list, you can reorganize entries by selecting the
    Up
    or
    Down
    buttons. The first entry in the list is displayed in the Properties view of the activity, link, or partner link.
Documentation appears as formatted tags in the Source view of your process and also in a report that you can generate.


Updated March 30, 2020