pub.monitor.process.model:generateModelImage
Generates the model image for a specified process model in SVG format. The service writes the generated image to the file system in IData format.
Input Parameters
The following table lists the input parameters.
modelID | String Model ID of the process model image to create. To retrieve model IDs, invoke the
pub.monitor.process.model:getModelNames service and use the value returned in the modelNames/PROCESSKEY output parameter. Note:
Whether Monitor treats modelID as case-sensitive or case-insensitive depends on how the underlying database (for example, Oracle, DB2, or SQL server) handles the queries that Monitor issues to obtain data. |
subNodeID | String Optional. Node ID of a step within the process model that represents an inline process (or subprocess) within the process; that is a set of steps that are collapsed into a single step. When you specify subnodeID, the service generates the image for the subprocess only, not for the entire process. To retrieve the node IDs for the subprocesses within a process, execute the
pub.monitor.process.modelSteps:getModelSteps service and use the value returned in the modelSteps/INLINESTEPID field. |
deployVersion | String The version of the process model for which you want to generate a model image. The model version for externally executed process models is always 1. There is no image associated with integration processes. |
Output Parameters
The following table lists the output parameters.
imageData | Document The generated image. The returned imageData document contains the following fields:  imageURL String URL of the image in the file system. width String Width of the image. height String Height of the image. type String Image type. The value is 2 for images in SVG format. |
| imageMap Document List A list of IDs for the child processes (that is, referenced processes and subprocesses) contained in the model. To obtain the details for one of these child processes, you can re-execute this service specifying its ID. For each child process in the mode, the following fields are returned: key String If the child process is a referenced process, key contains the model ID of the referenced process model. stepid String If the child process is a subprocess, stepid contains the ID of the step that represents the inline subprocess. x String The top x coordinate of the step icon for the child process. y String The left y coordinate of the step icon for the child process. x2 String The bottom x coordinate of the step icon for the child process. y2 String The right y coordinate of the step icon for the child process. |
imageError | String Errors that occurred while generating the image. |