Monitoring Services
Working with My webMethods
About this Guide
Logging Into and Logging Out of My webMethods
About Logging Into and Out of My webMethods
Logging Into My webMethods
Logging Out of My webMethods
Changing Your Password
Familiarizing Yourself with My webMethods
My webMethods User Interface
Resizing the Content Area and Navigation Pane
Standard Links
Tabs
Closing Tabs
Displaying a Page When its Tab is Not Visible
Re-arranging the Order of the Tabs
Navigation Pane
Application Selections Available in the Navigate Tab
Monitoring Section of the Navigate Tab
Administration Section of the Navigate Tab
Workspace Selections in the Navigate Tab
Tool Selections in the Tools Tab
Layout Section of the Tools Tab
MWS Monitoring and Diagnostics Section of the Tools Tab
Workspace Tools Section of the Tools Tab
Format of Application Pages
Format of Workspace Pages
Viewing and Updating Your My webMethods Profile
The My webMethods Profile
Identifying Yourself to My webMethods
Setting Your User Preferences
My webMethods User Preferences
Calendars
Defining Your Business Calendar
Viewing Your Personal User Calendar
Configuring the Time Zone in My webMethods
Changing the Time Zone in My webMethods
Working with My webMethods Workspaces
About Workspaces
About Creating New Workspaces
Creating New Empty Workspaces
Using “Save As” to Create a New Workspace
Defining the Layout of a Workspace
Opening Workspaces
Workspace Properties
Setting General Properties for a Workspace
Renaming Workspaces
Workspace Sharing
Workspace Sharing Permissions
Sharing Workspaces
Unsharing Workspaces
Closing Workspaces
Deleting Workspaces
About Adding Workspaces to the Navigation Pane
Adding Workspaces to the Navigation Pane
Removing Workspaces from the Navigation Pane
Adding a Workspace Folder to the Navigation Pane
Renaming a Workspace Folder in the Navigation Pane
Removing a Workspace Folder from the Navigation Pane
Working with Workspace Content
About Workspace Content
Adding Tools to a Workspace
Adding Windows from Application Pages to a Workspace
Adding Windows from a Workspace to Another Workspace
General Properties for a Window in a Workspace
Viewing Window Properties
Renaming a Window in a Workspace
Updating the Description of a Window
Finding Windows in a Workspace
Resizing Windows
Positioning Windows in a Workspace
Deleting Windows from a Workspace
Using Tools to Enhance Workspaces
MWS Monitoring and Diagnostics Tools
Workspace Tools
Attachments Tool
Attaching Files to a Workspace
Setting Preferences for an Attachments Window
Updating an Attachment
Removing an Attachment
Bookmarks Tool
Adding Bookmarks to a Workspace
Using the Bookmark Tool to Access Bookmarked Pages
Updating a Bookmark Title or URL
Changing Whether a Bookmark is Opened in the Current or New Window
Deleting Bookmarks
Directory Browser Tool
Adding Directory Browsers to Workspaces
HTML Text Tool
Adding Formatted Text to Workspaces
Updating Existing Formatted Text
Image Tool
Adding an Image to a Workspace
Updating an Image in a Workspace
Note Tool
Adding Simple Notes to a Workspace
Changing the Background Color of a Note
Adding the Last Update Date to a Note
Updating the Text of an Existing Note
User Calendar Tool
Adding Your Calendar to a Workspace
Changing to View Another User’s Calendar
Searching for Users, Groups, and Roles
About Searching for Users, Groups, and Roles
Keyword Searches for Users, Groups, and Roles
Performing a Keyword Search for Users, Groups, or Roles
Advanced Searches for Users and Groups
Performing an Advanced Search for Users or Groups
Searching for Data
About Searching for Data
Keyword Searches for Data
Determining the Fields that Keywords are Searched Against
Performing a Keyword Search for Data
Basic and Advanced Searches for Data
Saving Your Search
Re-executing a Saved Search
Modifying a Saved Search
Deleting a Saved Search
Setting Search Options for a My webMethods Page
Defining How My webMethods Displays Search Results
Sorting the Search Results
Resorting the Search Results
Defining the Number of Search Results Rows to Display Per Page
Setting the Columns to Display and Their Display Order
Working with Search Results
Taking Action Against Items in the Search Results
Taking Action Against Multiple Items in the Search Results
Adding Items
Taking Action Against a Single Item in the Search Results
Adding Search Results to a Workspace
Exporting Search Results to a .csv File
webMethods Audit Logging Guide
About this Guide
Types of Audit Logs
Overview
IS Core Audit Logging
Document Audit Logging
Guaranteed Delivery Audit Logging
Error Audit Logging
Mediator Transaction Logging
API Gateway Transaction Logging
Session Audit Logging
Service Audit Logging
Security Audit Logging
Process Audit Log
Business Process Audit Logging
Integration Process Audit Logging
Task Audit Logging
Universal Messaging Client Logging
Additional Processing for Audit Log Entries
Globalization
webMethods Broker Client Logging
webMethods Adapter Logging
Setting Up IS Core Audit Logging
Configure Audit Logging
Start the Logger Configuration
Enable the Logger
For the Service Logger, Choose the Logging Level
Identify the Destination
File Names and Locations
Database Error Handling
Configure Logging Mode (Synchronous or Asynchronous)
Configure Asynchronous Mode
Choose the Queue Provider
Choose Whether to Persist the Queue
Specify Maximum Queue Size
Specify the Connection Alias for the Universal Messaging Queue
Specify Reader Threads for the Universal Messaging Queue
Queue Fail-Fast Mode for Loggers that Use Universal Messaging Queues
Additional Fields for the Security Logger
Set Up Additional Service Logging
Set Up Customized Service Logging in Designer
Write User-Defined Messages or Input Pipelines to the Integration Server Server Log
Write Custom Values for the Current Context to the Integration Server Server Log
Write User-Defined Messages to the IS Core Audit Log
Send Messages About Service Failures to Email Addresses
Perform Additional Processing on Audit Log Entries
Controlling the Level of Exception Logging Detail
Controlling Date-Time Stamp and Time Zone Details
Rotate Audit Logs Based on Size
Limit the Number of Audit Log Files Kept by Integration Server
Receiving Notifications When Logging Fails
Fail-Fast Mode for Synchronous Logging
Queue Size Considerations for Fail-Fast Mode
Other Considerations for Using Fail-Fast Mode with Audit Logging
Setting Up Universal Messaging Client Logging
Configure the Client Logging
Viewing Audit Log Data
Overview
View the Audit Logs in Integration Server Administrator
View the Error Log
View the Guaranteed Delivery Log
View the Security Log
View the Service Log
View the Session Log
View the Mediator Transaction Logs
View the Universal Messaging Client Log
Change the Log Displays
Display Logged Data in Different Languages
Change the Display Permanently for All Logs
Change the Display Temporarily for a Particular Log
webMethods Monitor User’s Guide
About this Guide
Concepts
About webMethods Monitor
Architecture and Workflow
Data You Can Monitor
Monitoring Flow and Coded Services
Monitoring Documents
Monitoring webMethods-Executed Process Instances
Monitoring Externally Executed Processes
Monitoring Integration Processes
Monitoring Dynamically-Invoked Processes
About the Monitor User Interface
Monitor Administration Tasks
Monitoring Tasks
Archiving Data
Configuring Monitor
Overview
Identifying the Integration Servers to Be Monitored
Identifying the My webMethods Server that Hosts the Monitor User Interface
Configuring Database Connection Retries
Configuring Central User Management
Verifying the Configuration of Central User Management in Integration Server
Adding My webMethods Users to the Monitor ACLs
Customizing How Monitor Sets Up ACLs When Using Central User Management
Granting Users Access to Monitor
Configuring Access to Monitor Pages, Actions, and Data
Granting Users Access to Monitor Pages
Granting Users the Ability to Perform Monitor Actions
Identifying the Audit Data on Which Users Can Perform Actions
How Data-Level Security Works with Functional Privileges
Enabling Data-Level Security
Identifying Processes, Services, and/or Documents on Which a Role Can Act
Audit Data Archiving and Deletion in Monitor
Preliminary Requirements
Configuring Archive Settings
Configuring the Archive Database
Service Monitoring
About the Services Search Page
Finding Logged Service Data Using Keywords
Finding Logged Service Data Using an Advanced Search
Viewing Detailed Information for a Service
Service Statuses
Resubmitting a Service
Document Monitoring
About the Documents Search Page
Finding Logged Documents Using Keywords
Finding Logged Documents Using an Advanced Search
Viewing Detailed Information for a Document
Resubmitting a Document
Process Monitoring
Working with the Process Instances Page
Finding Process Instances Using Keywords
Finding Process Instances Using an Advanced Search
Customizing the Process Instance Search Options
Viewing Detailed Information for a Process Instance
About Process Instance Statuses
Process Instance Detailed Information
Setting the Priority for User Tasks in a Process Instance
Path Forecasting for a Process Instance
About Path Forecasting
Configuring Your System to Path Forecasting for a Process Instance
Viewing Estimated Data for a Forecast Path
Viewing Detailed Information for a Process Step
About Process Instance Step Statuses
Viewing Steps Within a Subprocess
Viewing a Call Activity Step
Process Step Detailed Information
About Subprocess Detailed Information
About Subprocess and Call Activity Duration Time
Viewing KPI Data for Process Instances
Viewing KPI Data Associated with a Process Step
Stopping, Suspending, or Resuming a Process Instance
Updating a Process Instance to a New Model Version
About Resubmitting Process Instances and Process Steps
Enabling Your System to Resubmit Processes
Requirements for Submitting Process Instances
Resubmittal Behavior in the Run Time
Resubmitting Processes from a Step and Optionally Editing Pipeline Information
Example Resubmittal Use Cases
Unhandled Exception
Handled Exceptions
Steps Enabled for Resubmission
Resubmitting Completed Processes
Working with Process Models
Finding Process Model Information in My webMethods
Using the Business Processes Page
Finding Process Models Using Keywords
Finding Process Models Using an Advanced Search
Customizing the Process Model Search Options
Viewing and Modifying Process Model Information
Working with the Edit Process Page
Process Information Administration Window
Process Details Tab
Process Settings Tab
Step Settings Tab
Instance Analytics Tab
Process Stages and EDA Events Window
Stages Tab
Events Tab
Process Diagram Window
About Process Model Data Logging
About Process Model Logging Levels
Improving Process Logging Performance
Configuring Logging Settings for a Process Model Version
Enabling and Disabling Process Instance Diagnostic Logging
Viewing a Process Instance Diagnostic Logging File
Enabling and Disabling Process Model Versions
Determining the Enabled Version of a Process Model
Enabling or Disabling a Process Model for Analysis
Enabling and Disabling EDA Event Emission
Enabling and Disabling a Step for Resubmission
Working with Stages and Milestones
Adding a Stage
Modifying a Stage
Deleting a Stage
Viewing Stages in the Process Diagram
About Synchronizing Stages and Events with Software AG Designer
Deleting Unused Process Models
Upgrading Process Models
About Process Model Rendering
Modifying the Default Header Rule for Internet Explorer
Defining, Executing, and Logging Integration Processes
Logging an Integration Process
Defining an Integration Process
Executing an Integration Process
Archiving or Deleting Data in an Archive Database
Overview
Archiving or Deleting Audit Data Using the Monitor User Interface
Archiving or Deleting Audit Data Using Built-in Services
Archiving or Deleting Audit Data Using Stored Procedures
Viewing the Results of an Archive Operation
Archiving Data Using Partitions
Overview of Using Partitions for Process Audit Log Data
Configuring Partitions
Using Mobile Monitor
Understanding Mobile Monitor
About Notifications
Configuring Mobile Monitor
Archive Tables
Overview
Process Archive Tables
Server Archive Tables
Service Archive Tables
Document Archive Tables
webMethods Monitor Built-in Services Reference
About this Guide
pub.monitor.archive Folder
Summary of Elements in This Folder
pub.monitor.archive:documentArchive
pub.monitor.archive:getArchiveInfo
pub.monitor.archive:processArchive
pub.monitor.archive:serverArchive
pub.monitor.archive:serviceArchive
pub.monitor.archive:setOperationParameters
pub.monitor.document Folder
Summary of Elements in This Folder
pub.monitor.document:exists
pub.monitor.document:getActions
pub.monitor.document:getDetails
pub.monitor.document:getDocument
pub.monitor.document:getList
pub.monitor.documentControl Folder
Summary of Elements in This Folder
pub.monitor.documentControl:resubmit
pub.monitor.integrationProcessLogging Folder
Summary of Elements in This Folder
pub.monitor.integrationProcessLogging:createLoggedFieldInstance
pub.monitor.integrationProcessLogging:createLoggedFieldMetadata
pub.monitor.integrationProcessLogging:createProcessError
pub.monitor.integrationProcessLogging:createProcessInstance
pub.monitor.integrationProcessLogging:createProcessMetadata
pub.monitor.integrationProcessLogging:createStepInstance
pub.monitor.integrationProcessLogging:createStepMetadata
pub.monitor.integrationProcessLogging:generateProcessInstanceID
pub.monitor.integrationProcessLogging:updateProcessInstanceStatus
pub.monitor.integrationProcessLogging:updateStepInstanceStatus
pub.monitor.process.actions Folder
Summary of Elements in This Folder
pub.monitor.process.actions:CustomImplOutputDoc
pub.monitor.process.instance Folder
Summary of Elements in This Folder
pub.monitor.process.instance:generateInstanceImage
pub.monitor.process.instance:getDocumentNames
pub.monitor.process.instance:getFieldNames
pub.monitor.process.instance:getInstance
pub.monitor.process.instance:getInstanceActivityLogs
pub.monitor.process.instance:getInstanceControl
pub.monitor.process.instance:getInstanceConversationID
pub.monitor.process.instance:getInstanceCustomData
pub.monitor.process.instance:getInstanceErrors
pub.monitor.process.instance:getInstanceList
pub.monitor.process.instance:getInstanceListByQueryName
pub.monitor.process.instance:getInstanceListCustomData
pub.monitor.process.instance:getInstanceListCustomData Set
pub.monitor.process.instance:getInstanceListWithFilter
pub.monitor.process.instance:getInstanceModelInfo
pub.monitor.process.instance:getInstanceSteps
pub.monitor.process.instance:getInstanceTransitions
pub.monitor.process.instance:getPagedInstanceList
pub.monitor.process.instance:getProcessList
pub.monitor.process.instance:getRecentlyCompleted
pub.monitor.process.instance:getRecentlyCreated
pub.monitor.process.instance:getRecentlyFailed
pub.monitor.process.instance:getRecentlySuspended
pub.monitor.process.instanceControl Folder
Summary of Elements in This Folder
pub.monitor.process.instanceControl:changeInstanceStatus
pub.monitor.process.instanceControl:changeUserTaskPriority
pub.monitor.process.instanceControl:resubmitAllFailed
pub.monitor.process.instanceControl:resubmitInstanceStep
pub.monitor.process.instanceSteps Folder
Summary of Elements in This Folder
pub.monitor.process.instanceSteps:getStepActivityLogs
pub.monitor.process.instanceSteps:getStepControl
pub.monitor.process.instanceSteps:getStepCustomData
pub.monitor.process.instanceSteps:getStepDetails
pub.monitor.process.instanceSteps:getStepErrors
pub.monitor.process.instanceSteps:getStepHistory
pub.monitor.process.instanceSteps:getStepPipeline
pub.monitor.process.model Folder
Summary of Elements in This Folder
pub.monitor.process.model:clearProcessFilter
pub.monitor.process.model:generateModelImage
pub.monitor.process.model:getCustomFieldDefinitions
pub.monitor.process.model:getCustomFields
pub.monitor.process.model:getModelDetails
pub.monitor.process.model:getModelImage
pub.monitor.process.model:getModelList
pub.monitor.process.model:getModelListWithFilter
pub.monitor.process.model:getModelNames
pub.monitor.process.model:getModelNamesWithFilter
pub.monitor.process.model:getProcessFilter
pub.monitor.process.model:getUnusedModels
pub.monitor.process.model:setProcessFilter
pub.monitor.process.modelControl Folder
Summary of Elements in This Folder
pub.monitor.process.modelControl:changeModelEnabled
pub.monitor.process.modelControl:deleteUnusedModel
pub.monitor.process.modelControl:getProcessLogical Servers
pub.monitor.process.modelControl:isModelEnabled
pub.monitor.process.modelControl:refreshModelNames
pub.monitor.process.modelSteps Folder
Summary of Elements in This Folder
pub.monitor.process.modelSteps:getModelSteps
pub.monitor.process.modelSteps:getModelTransitions
pub.monitor.process.modelSteps:getStepIDNames
pub.monitor.service Folder
Summary of Elements in This Folder
pub.monitor.service:exists
pub.monitor.service:getActions
pub.monitor.service:getActivityLogs
pub.monitor.service:getChildDetails
pub.monitor.service:getCustomData
pub.monitor.service:getDetails
pub.monitor.service:getErrors
pub.monitor.service:getHistory
pub.monitor.service:getList
pub.monitor.service:getListCustomData
pub.monitor.service:getListCustomDataSet
pub.monitor.service:getPipeline
pub.monitor.service:isResubmittable
pub.monitor.serviceControl Folder
Summary of Elements in This Folder
pub.monitor.serviceControl:resubmit
Status Reference
Statuses
Legal Notices
Copyright
Monitoring Services
Copyright
to-monservices_landing_page
to-logging_into_and_logging_out_of_my_webmethods
co-about_logging_into_and_out_of_my_webmethods
ta-logging_into_my_webmethods
ta-logging_out_of_my_webmethods
ta-changing_your_password
to-familiarizing_yourself_with_my_webmethods
co-my_webmethods_user_interface
ta-resizing_the_content_area_and_navigation_pane
re-standard_links
co-tabs
ta-closing_tabs
ta-displaying_a_page_when_its_tab_is_not_visible
ta-re-arranging_the_order_of_the_tabs
co-navigation_pane
co-application_selections_available_in_the_navigate_tab
re-monitoring_section_of_the_navigate_tab
re-administration_section_of_the_navigate_tab
re-workspace_selections_in_the_navigate_tab
co-tool_selections_in_the_tools_tab
re-layout_section_of_the_tools_tab
re-mws_monitoring_and_diagnostics_section_of_the_tools_tab
re-workspace_tools_section_of_the_tools_tab
co-format_of_application_pages
co-format_of_workspace_pages
to-viewing_and_updating_your_my_webmethods_profile
co-the_my_webmethods_profile
ta-identifying_yourself_to_my_webmethods
ta-setting_your_user_preferences
re-my_webmethods_user_preferences
co-calendars
ta-defining_your_business_calendar
ta-viewing_your_personal_user_calendar
ta-changing_time_zone
to-working_with_my_webmethods_workspaces
co-about_workspaces
co-about_creating_new_workspaces
ta-creating_new_empty_workspaces
ta-using_save_as_to_create_a_new_workspace
ta-defining_the_layout_of_a_workspace
ta-opening_workspaces
re-workspace_properties
ta-setting_general_properties_for_a_workspace
ta-renaming_workspaces
co-workspace_sharing
re-workspace_sharing_permissions
ta-sharing_workspaces
ta-unsharing_workspaces
ta-closing_workspaces
ta-deleting_workspaces
co-about_adding_workspaces_to_the_navigation_pane
ta-adding_workspaces_to_the_navigation_pane
ta-removing_workspaces_from_the_navigation_pane
ta-adding_a_workspace_folder_to_the_navigation_pane
ta-renaming_a_workspace_folder_in_the_navigation_pane
ta-removing_a_workspace_folder_from_the_navigation_pane
to-working_with_workspace_content
co-about_workspace_content
ta-adding_tools_to_a_workspace
ta-adding_windows_from_application_pages_to_a_workspace
ta-adding_windows_from_a_workspace_to_another_workspace
re-general_properties_for_a_window_in_a_workspace
ta-viewing_window_properties
ta-renaming_a_window_in_a_workspace
ta-updating_the_description_of_a_window
ta-finding_windows_in_a_workspace
ta-resizing_windows
ta-positioning_windows_in_a_workspace
ta-deleting_windows_from_a_workspace
to-using_tools_to_enhance_workspaces
re-mws_monitoring_and_diagnostics_tools
re-workspace_tools
co-attachments_tool
ta-attaching_files_to_a_workspace
ta-setting_preferences_for_an_attachments_window
ta-updating_an_attachment
ta-removing_an_attachment
co-bookmarks_tool
ta-adding_bookmarks_to_a_workspace
ta-using_the_bookmark_tool_to_access_bookmarked_pages
ta-updating_a_bookmark_title_or_url
ta-changing_whether_a_bookmark_is_opened_in_the_current_or_new_window
ta-deleting_bookmarks
co-directory_browser_tool
ta-adding_directory_browsers_to_workspaces
co-html_text_tool
ta-adding_formatted_text_to_workspaces
ta-updating_existing_formatted_text
co-image_tool
ta-adding_an_image_to_a_workspace
ta-updating_an_image_in_a_workspace
co-note_tool
ta-adding_simple_notes_to_a_workspace
ta-changing_the_background_color_of_a_note
ta-adding_the_last_update_date_to_a_note
ta-updating_the_text_of_an_existing_note
co-user_calendar_tool
ta-adding_your_calendar_to_a_workspace
ta-changing_to_view_another_user’s_calendar
to-searching_for_users_groups_and_roles
co-about_searching_for_users_groups_and_roles
co-keyword_searches_for_users_groups_and_roles
ta-performing_a_keyword_search_for_users_groups_or_roles
co-advanced_searches_for_users_and_groups
ta-performing_an_advanced_search_for_users_or_groups
to-searching_for_data
co-about_searching_for_data
co-keyword_searches_for_data
ta-determining_the_fields_that_keywords_are_searched_against
ta-performing_a_keyword_search_for_data
co-basic_and_advanced_searches_for_data
ta-saving_your_search
ta-re-executing_a_saved_search
ta-modifying_a_saved_search
ta-deleting_a_saved_search
ta-setting_search_options_for_a_my_webmethods_page
co-defining_how_my_webmethods_displays_search_results
ta-sorting_the_search_results
ta-resorting_the_search_results
ta-defining_the_number_of_search_results_rows_to_display_per_page
ta-setting_the_columns_to_display_and_their_display_order
co-working_with_search_results
co-taking_action_against_items_in_the_search_results
ta-taking_action_against_multiple_items_in_the_search_results
ta-adding_items
ta-taking_action_against_a_single_item_in_the_search_results
ta-adding_search_results_to_a_workspace
ta-exporting_search_results_to_a_csv_file
to-setting_up_audit_logging
to-setting_up_um_client_logging
to-viewing_audit_log_data
to-concepts
to-setup
to-services
to-documents
to-processes
to-process_models
to-integration_process
to-archive_data
to-partitioning
to-mobile_application
to-archive_tables
to-about_this_guide
to-archive_folder
to-document_folder
to-document_control_folder
to-integration_process-log
to-process_actions_folder
to-process_instance_folder
to-process_instance_control_folder
to-process_instance_steps_folder
to-process_model_folder
to-process_model_control_folder
to-process_model_steps_folder
to-service_folder
to-service_control_folder
to-appx_statuses
to-online-copyright-page