Service Documentation Builder
In this topic ...
Related Topics ...
The Service Documentation Builder generates a report on services published or used by a specified model or models. When a model containing this Builder is run, the model produces a page that displays information on the selected services, their operations and parameters.
This Builder can display documentation about any data service, including those defined by Service Definition Builders or by integration Builders such as SQL Call, Domino View & Form, SAP Function, etc.
How do I
Document a Data Service
More How Do I... Topics
Specifying Inputs
This Builder takes the inputs described in the table below. For help on inputs common to many or all Builders such as those in the Properties input group, see "Using the Builder Call Editor."
Input Name Description Name Enter a name for this Builder call. The Designer displays this name in the Builder Call List. This entry is used as the local name of service. If this input is blank or if "Add All Target Methods" is enabled, the target method name will be used.
Model Selection Choose which models will be examined by this Builder for services. You can choose:
- All service models - To view services in all models that publish a public service
- Service models matching pattern -To examine all models whose names match a specified regular expression
- This model - To generate the report on services published/used by the model in which the Service Documentation Builder call is present
- Specific model -To list services published/used by a single model other than the model in which this Builder is located
Pattern This input is available when "Service models matching pattern" is specified as the Model Selection input above. Enter a regular expression pattern used to filter the set of models examined for services.
Example: services/Customer.*
Model This input is available when "Specific model" is specified as the Model Selection input above. Specify the name of the model to be examined for services.
Report Type Choose documentation to generate about on the public services published by the selected model(s), or the services consumed. We can choose:
- Services implemented -Report will contain information on the public services created/published by the Service Definition Builder in the selected model(s)
- Services used -Report will detail all data services present in the selected model(s), generally corresponding to services used or consumed.
Generate Main Enable to force Builder to create a "main" action that displays the page containing the service report. If you enable this feature, not have another action called "main" in the model.
If this input is disabled, invoke the documentation page at the appropriate time by another method. This page is named: builder_call_nameDocumentationPage
Show Schema Elements Enable to include in the report all of the sub-elements in the schemas used as the types of service parameters If schemas are large, enabling this feature can make the display difficult to read.
Display Settings Outer Page HTML Use this input to specify an alternate base HTML page for the outer report display page. Be sure to include the same named elements in this page as are used in the default HTML page located in: factory/pages/ServiceDocumentation/outer.html
Model Page HTML Use this input to specify an alternate base HTML page for the second level display page (one instance per model.) Be sure to include the same named elements in this page as are used in the default HTML page located in: factory/pages/ServiceDocumentation/model.html
Service Page HTML Use this input to specify an alternate base HTML page for the third level report display page, used to show service-specific information. Be sure to include the same named elements in this page as are used in the default HTML page located in: factory/pages/ServiceDocumentation/service.html
Operation Page HTML Use this input to specify an alternate base HTML page for the inner report display page, used to show information about each operation. Be sure to include the same named elements in this page as are used in the default HTML page located in: factory/pages/ServiceDocumentation/operation.html
Advanced Model Name The default setting for this input specifies the model: factory/portletbase/service_documentation_base This model contains all the Builders and profiling required for the model to function and, as a result, this input should not be changed.
In some cases a custom version of this model might be required, leveraging some additional (profiled) functionality. This input allows you to specify an alternate version of the service_documentation_base model
Objects Created by the this Builder
A variety of WebApp artifacts are created by this Builder. In general, these are used only by the Builder's runtime code to generate the service report. You should not have to interact with these objects.