SAP SF Execution Monitor
Collects the exceptions from the Execution Management that is configured on the SuccessFactors cloud service. The monitoring categories Middleware Integration, Scheduled Job, Integration Center and Smart Suite are covered.
General
| Executable | SAP_SF_Execution_Monitor.exe |
| Connection method | HTTP |
| Ports |
|
Prerequisites
You'll nedd an API user with sufficient permissions for Basic Auth (see also SAP Note 2956021):
Navigate to Admin Center > Manage Permission Roles
- Manage Integration Tools:
- Allow Admin to Access OData API through Basic Authentication
- Admin Center Permissions:
- Read Execution Manager Events
- Read Execution Manager Event Payload or Event Reports
- Monitor Scheduled Jobs
Default parameters
| Parameter name | Possible values | Default | Description |
|---|---|---|---|
| SAPUsername | string | empty | SF API user |
| SAPPassword | string | empty | Password of the SF API user |
Sensor-specific parameters
| Parameter name | Possible values | Default | Description |
|---|---|---|---|
| Minutes | number | 1 - n | 60 | Past minutes in which the exceptions from the Execution Manager on SuccessFactors cloud service are collected. |
| Url | <url> | empty | The URL of your SAP Successfactors instance. Example: Check the following note to find the correct API Url: SAP Note 2215682 |
| AuthenticationMethod | Basic | OAuth | Basic | Authentication method to use. The Basic authentication method will be out of maintenance from June 2, 2023. |
| APIKey | <token> | NONE | API key if you use Check the documentation here for further information: |
| PrivateKey | <private_key> (without -----BEGIN/END PRIVATE KEY-----) | NONE | Private key of the x509 certificate. Only needed if OAuth is used as the authentication method. |
| IntegrationCenterJobName | <jobname1>,<jobname2>,... | * | Filter for integration center job(s) ( Use * as wildcard. |
| ScheduledJobName | <jobname1>,<jobname2>,... | * | Filter for scheduled job(s) ( Use * as wildcard. |
Channels
| Channel name | Description | Lookup file |
|---|---|---|
| Scheduled job - successfully | Total number of scheduled jobs which have been completed successfully | |
| Scheduled job - errors | Total number of scheduled jobs which have been completed with errors | |
| Scheduled job - failed | Total number of scheduled jobs which failed | |
| Scheduled job - in progress | Total number of scheduled jobs which are in progress | |
| Scheduled job - warnings | Total number of scheduled jobs which have been completed with warnings | |
| Middleware integration - successfully | Total number of middleware integrations which have been completed successfully | |
| Middleware integration - errors | Total number of middleware integrations which have been completed with errors | |
| Middleware integration - failed | Total number of middleware integrations which failed | |
| Middleware integration - in progress | Total number of middleware integrations which are in progress | |
| Middleware integration - warnings | Total number of middleware integrations which have been completed with warnings | |
| Integration center - successfully | Total number of integration center events which have been completed successfully | |
| Integration center - errors | Total number of integration center events which have been completed with errors | |
| Integration center - failed | Total number of integration center events which failed | |
| Integration center - in progress | Total number of integration center events which are in progress | |
| Integration center - warnings | Total number of integration center events which have been completed with warnings | |
| Smart Suite - successfully | Total number of smart suite events which have been completed successfully | |
| Smart Suite - errors | Total number of smart suite events which have been completed with errors | |
| Smart Suite - failed | Total number of smart suite events which failed | |
| Smart Suite - in progress | Total number of smart suite events which are in progress | |
| Smart Suite - warnings | Total number of smart suite events which have been completed with warnings |
Important notes
Please check the channel limits in PRTG if they fit for your alerting.
The time zone of SF is UTC.
Changelog
| Version | Changes |
|---|---|
| 2023.06 | Added additional parameters to filter for one or more scheduled jobs and / or integration center jobs. |
| 2023.03 | Added possibility to use authentication method OAuth. |
| 2021.06 | First stable release |