Copyright © Cloud Software Group, Inc. All Rights Reserved

Manage Monitor Event Request Tool

The iProcess Workspace (Browser) application provides a tool that can be used to create new, or edit existing, MER messages on the iProcess Engine. To access this tool, from the procedure list:

•	select Tools > Manage Monitor Event Request, or

•	click the icon on the toolbar.

These selections cause the Manage Monitor Event Request dialog to be displayed, which provides options to do the following:

•

Create New Monitor Event Request - Use this option if you want to create a new MER message. This sets the <FullImport> element in the MER XML to true, which causes the new MER message to overwrite any existing MER message on the iProcess Engine. (To view the existing MER message on the iProcess Engine, you can select the Edit Monitor Event Request on the Server option, then cancel out of it, if desired.)

•

Edit Monitor Event Request on the Server - Use this option if you want to edit an existing MER message on the iProcess Engine. This allows you to add additional MonitorDetails to any existing MonitorDetails, or to edit an existing MonitorDetail. This sets the <FullImport> element in the MER XML to true.

•	Import Monitor Event Request XML - Use this option to either import or construct the MER XML manually. When using this option, you can set the <FullImport> element to true to overwrite an existing MER, or to false to append to an existing MER.

Create New Monitor Event Request

To create a new MER message, and overwrite any existing MER message on the iProcess Engine:

1.	From the Manage Monitor Event Request dialog, select the Create New Monitor Event Request option.

2.	On the Monitor Event Request Definition dialog, click the icon.

3.	From the Procedure field drop-down list on the Add Monitor Detail dialog, select the procedure whose events you want to monitor.

The causes the GlobalFieldList to be populated with all of the fields defined in the selected procedure.

4.

In the Available Fields list, select the “global fields” whose data will be exported for every monitored event defined for this MonitorDetail (the <GlobalFieldList> element of the MER). Global fields are optional. (You can later select fields for a specific MonitorLine included in the MonitorDetail.)

5.	If you have selected any global fields, move them to the Selected Fields list:

6.	In the MonitorList section, click the icon.

This causes the Add MonitorLine dialog to be displayed, which is used to define the <MonitorLine> element in the MER XML. This dialog displays a list of all activities (audit events), steps, and fields that are defined in the previously selected procedure:

7.	From the ActivityList, select all of the audit events that you want to publish.

This list contains all available events on the iProcess Engine, including custom events that have been configured. You may select multiple events, or select “ALL” to publish all events. At least one event must be selected.

8.	From the StepList, select the steps for which the selected activities (events) are to be published.

This list contains all steps defined for the procedure. You may select multiple steps, or select “ALL” to publish activities on all steps. At least one step must be selected.

9.	From the FieldList, optionally select fields whose data you want published.

This list contains all fields defined for the procedure. Global fields, which were selected on the MonitorDetail dialog (see step 4), are automatically selected and labeled with "(Global)". Global fields may not be deselected because they apply to all MonitorLines that are defined. Additional fields may be selected. Data for all selected fields is published for the selected activities and steps. Selection of fields is optional.

10.	After making the desired selections from the lists on the Add MonitorLine dialog, click OK.

The <MonitorLine> created by the selections on the Add MonitorLine dialog is displayed on the bottom of the Add MonitorDetail dialog:

Note that the <MonitorLine> does not include any global fields, if specified, because they apply to all MonitorLines for the MonitorDetail.

Also, because the schema does not provide the ability to specify a name for uniquely identifying each <MonitorLine> element, a name is generated for display purposes in the MonitorList. The generated name consists of "MonitorLine #". This name is for display purposes only and is not reflected in the XML. The MonitorLine number only signifies the position of the item in the list, if an item is removed, all the MonitorLines are renumbered — the names in the list are not static.

You can re-visit a MonitorLine definition, if desired, by selecting the MonitorLine, then clicking the icon. You can also delete an existing MonitorLine by selecting it, then clicking the icon.

11.	Optionally repeat step 6 through step 10 if you want to define additional MonitorLines for the MonitorDetail, which could include different combinations of activities, steps, and fields.

12.	On the Add MonitorDetail dialog, click OK.

The entire <MonitorDetail> that you have defined is shown on the Monitor Event Request Definition dialog:

13.	Choose one of the following options for the new MER XML:

−	Send MER to Server - This option writes the MER XML to the iProcess Engine, overwriting any existing MER.

−	Export MER XML - This option causes the Export Monitor Event Request XML dialog to be displayed, which allow you to copy the definition of the MER XML to the clipboard for the purpose of pasting into an external file.

If you are running the application in Microsoft Internet Explorer, a Copy button is provided on the Export Monitor Event Request XML dialog to copy the XML to the clipboard. If you are running the application in Mozilla Firefox, there is no Copy button because security features prevent browser access to the clipboard.

Edit Monitor Event Request on the Server

To edit an existing MER message on the iProcess Engine:

1.	From the Manage Monitor Event Request dialog, select the Edit Monitor Event Request on server option.

The MonitorDetails list is populated with all MonitorDetails that are currently defined on the iProcess Engine:

2.	On the MonitorDetails list, select one of the following options:

−	- The causes the Add Monitor Detail dialog to display, which allows you to add a new MonitorDetail to the existing MER.

If you are adding a new MonitorDetail, follow the procedure in Adding a New MonitorDetail to an Existing MER.

−	- This causes the Edit Monitor Detail dialog to display, which allows you to edit the MonitorDetail that is currently selected in the MonitorDetails list.

If you are editing an existing MonitorDetail, follow the procedure in Editing an Existing MonitorDetail in the MER.

−	- This deletes the MonitorDetail that is currently selected in the MonitorDetails list.

After deleting an existing MonitorDetail, you can click on of the other icons to either add a different MonitorDetail or edit an existing MonitorDetail, or you can click Send MER to Server to remove the deleted MonitorDetail from the MER on the iProcess Engine.

Adding a New MonitorDetail to an Existing MER

1.	Click the icon on the Monitor Event Request Definition dialog.

2.	From the Procedure field drop-down list on the Add Monitor Detail dialog, select a procedure whose events you want to monitor.

Note that the list of procedures does not include any procedures for which there is already a MonitorDetail defined in the MER on the iProcess Engine.

The causes the GlobalFieldList to be populated with all of the fields defined in the selected procedure.

3.

In the Available Fields list, select the “global fields” whose data will be exported for every monitored event defined for this MonitorDetail (the <GlobalFieldList> element of the MER). Global fields are optional. (You can later select fields for a specific MonitorLine included in the MonitorDetail.)

4.	If you have selected any global fields, move them to the Selected Fields list:

5.	In the MonitorList section, click the icon.

This causes the Add MonitorLine dialog to be displayed, which is used to define the <MonitorLine> element in the MER XML. This dialog displays a list of all activities (audit events), steps, and fields that are defined in the previously selected procedure:

6.	From the ActivityList, select all of the audit events that you want to publish.

This list contains all available events on the iProcess Engine, including custom events that have been configured. You may select multiple events, or select “ALL” to publish all events. At least one event must be selected.

7.	From the StepList, select the steps for which the selected activities (events) are to be published.

This list contains all steps defined for the procedure. You may select multiple steps, or select “ALL” to publish activities on all steps. At least one step must be selected.

8.	From the FieldList, optionally select fields whose data you want published.

This list contains all fields defined for the procedure. Global fields, which were selected on the MonitorDetail dialog (see step 4), are automatically selected and labeled with "(Global)". Global fields may not be deselected because they apply to all MonitorLines that are defined. Additional fields may be selected. Data for all selected fields is published for the selected activities and steps. Selection of fields is optional.

9.	After making the desired selections from the lists on the Add MonitorLine dialog, click OK.

The <MonitorLine> created by the selections on the Add MonitorLine dialog is displayed on the bottom of the Add MonitorDetail dialog:

Note that the <MonitorLine> does not include any global fields, if specified, because they apply to all MonitorLines for the MonitorDetail.

Also, because the schema does not provide the ability to specify a name for uniquely identifying each <MonitorLine> element, a name is generated for display purposes in the MonitorList. The generated name consists of "MonitorLine #". This name is for display purposes only and is not reflected in the XML. The MonitorLine number only signifies the position of the item in the list, if an item is removed, all the MonitorLines are renumbered — the names in the list are not static.

You can re-visit a MonitorLine definition, if desired, by selecting the MonitorLine, then clicking the icon. You can also delete an existing MonitorLine by selecting it, then clicking the icon.

10.	Optionally repeat step 5 through step 9 if you want to define additional MonitorLines for the MonitorDetail, which could include different combinations of activities, steps, and fields.

11.	On the Add MonitorDetail dialog, click OK.

12.	On the Monitor Event Request Definition dialog, choose one of the following options for the edited MER XML:

−	Send MER to Server - This option saves the edited MER message on the iProcess Engine.

−	Export MER XML - This option causes the Export Monitor Event Request XML dialog to be displayed, which allows you to copy the definition of the MER XML to the clipboard for the purpose of pasting into an external file.

If you are running the application in Microsoft Internet Explorer, a Copy button is provided on the Export Monitor Event Request XML dialog to copy the XML to the clipboard. If you are running the application in Mozilla Firefox, there is no Copy button because security features prevent browser access to the clipboard.

Editing an Existing MonitorDetail in the MER

1.	On the Monitor Event Request Definition dialog,, select the MonitorDetail you want to edit, then click the icon

2.

On the Edit MonitorDetail dialog, optionally add or remove “global fields” from the MonitorDetail. Global fields are fields whose data will be exported for every monitored event defined for this MonitorDetail (the <GlobalFieldList> element of the MER). Global fields are optional. (You can later select fields for a specific MonitorLine included in the MonitorDetail.)

3.	If you only wanted to edit the global fields for this MonitorDetail, click OK, then proceed to step 8.

4.	At this point, you can either:

−	Add an additional MonitorLine to the MonitorDetail - click the icon.

−	Edit an existing MonitorLine defined for the MonitorDetail - select the desired MonitorLine, then click the icon.

If you are adding an additional MonitorLine, the Add MonitorLine dialog is displayed; if you are editing an existing MonitorLine, the Edit MonitorLine dialog is displayed.

5.	Define the MonitorLine on the Add / Edit MonitorLine dialog as follows:

a.	From the ActivityList, select all of the audit events that you want to publish for this MonitorLine.

This list contains all available events on the iProcess Engine, including custom events that have been configured. You may select multiple events, or select “ALL” to publish all events. At least one event must be selected.

b.	From the StepList, select the steps for which the selected activities (events) are to be published.

This list contains all steps defined for the procedure. You may select multiple steps, or select “ALL” to publish activities on all steps. At least one step must be selected.

c.	From the FieldList, optionally select fields whose data you want published.

This list contains all fields defined for the procedure. Global fields, which were selected on the MonitorDetail dialog (see step 2), are automatically selected and labeled with "(Global)". Global fields may not be deselected because they apply to all MonitorLines that are defined. Additional fields may be selected. Data for all selected fields is published for the selected activities and steps. Selection of fields is optional.

6.	After making the desired selections from the lists on the Add / Edit MonitorLine dialog, click OK.

All of the currently defined MonitorLines are shown in the MonitorList:

Note that the <MonitorLine> does not include any global fields, if specified, because they apply to all MonitorLines for the MonitorDetail.

Also, because the schema does not provide the ability to specify a name for uniquely identifying each <MonitorLine> element, a name is generated for display purposes in the MonitorList. The generated name consists of "MonitorLine #". This name is for display purposes only and is not reflected in the XML. The MonitorLine number only signifies the position of the item in the list, if an item is removed, all the MonitorLines are renumbered — the names in the list are not static.

You can re-visit a MonitorLine definition, if desired, by selecting the MonitorLine, then clicking the icon. You can also delete an existing MonitorLine by selecting it, then clicking the icon.

7.	Optionally repeat step 4 through step 6 if you want to define additional MonitorLines for the MonitorDetail, which could include different combinations of activities, steps, and fields.

8.	On the Add / Edit MonitorDetail dialog, click OK.

9.	On the Monitor Event Request Definition dialog, choose one of the following options for the edited MER XML:

−	Send MER to Server - This option saves the edited MER message on the iProcess Engine.

−	Export MER XML - This option causes the Export Monitor Event Request XML dialog to be displayed, which allows you to copy the definition of the MER XML to the clipboard for the purpose of pasting into an external file.

If you are running the application in Microsoft Internet Explorer, a Copy button is provided on the Export Monitor Event Request XML dialog to copy the XML to the clipboard. If you are running the application in Mozilla Firefox, there is no Copy button because security features prevent browser access to the clipboard.

Import Monitor Event Request XML

The Import Monitor Event Request XML option provides a means to either import or construct the MER XML manually.

1.	From the Manage Monitor Event Request dialog, select the Import Monitor Event Request XML option.

2.	On the Import Monitor Event Request XML dialog, either type or paste the desired XML into the dialog, then click OK.

The Monitor Event Request Definition dialog is displayed, containing the MER definition that was in the Import Monitor Event Request XML dialog when you clicked OK.

3.	On the Monitor Event Request Definition dialog, choose one of the following options for the imported MER XML:

−	Send MER to Server - This option saves the imported MER message on the iProcess Engine.

−	Export MER XML - This option causes the Export Monitor Event Request XML dialog to be displayed, which allows you to copy the definition of the MER XML to the clipboard for the purpose of pasting into an external file.

If you are running the application in Microsoft Internet Explorer, a Copy button is provided on the Export Monitor Event Request XML dialog to copy the XML to the clipboard. If you are running the application in Mozilla Firefox, there is no Copy button because security features prevent browser access to the clipboard.

 

Copyright © Cloud Software Group, Inc. All Rights Reserved