Loading

dnb-logo
Direct 2.0
Collapse

Create Monitoring Profile

This function allows a customer to specify which data layer (or portion thereof) should be monitored and the condition(s) that should trigger change notices.

A Monitoring Profile establishes the specific data fields within a given data layer that should be monitored, and the conditions under which a change event should be triggered.

Update History

No modifications have been made to this data layer since the initial release.

Feature Request

IMPORTANT: Please see the new Online Services Security Enhancement Release, effective November 09, 2020.

Overview

When providing PCMElementXPATHText values, the format should be "//Organization/..." WITHOUT any spaces. Some data elements may only be monitored by the associated aggregate or attribute XPATH.

Example:

As displayed in documentationValue in PCMElementXPATHText
OrderProductResponse. OrderProductResponseDetail. Product. Organization. Events. PublicFilingHeader. DisclaimerText//Organization /Events /PublicFilingHeader /DisclaimerText

Data Layer Entitlement

For customers in U.S. and Canadian markets, the API is provisioned for specific collections of products, reports, and/or features (collectively referred to as data layers) for production and trial usage. Entitlement is not required for testing in the sandbox environment.

  • This function does not require entitlement for production and trial usage. Entitlement for monitoring is only required for the Add Monitoring Registration function, and for the data layers that will monitored.

Specification

Please refer to the list of products that may be included in the Monitoring process.

Sample Request (Create)
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mon="http://services.dnb.com/MonitoringServiceV2.0">
     <soapenv:Header>
      <wsse:Security soapenv:mustUnderstand="0" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken wsu:Id="UsernameToken-7" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
            <wsse:Username>MyUserName</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">MyPassword</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
       <mon:CreateMonitoringProfileRequest ServiceVersionNumber="4.0">
         <CreateMonitoringProfileRequestDetail>
            <MonitoringProfileSpecification>
               <MonitoringProfileName>Monitor_DCP_PREM_Product</MonitoringProfileName>
               <MonitoringProfileDescription>Monitor_DCP_PREM_Product</MonitoringProfileDescription>
               <DNBProductID>DCP_PREM</DNBProductID>
               <MonitoringLevel>Level2</MonitoringLevel>
            </MonitoringProfileSpecification>
         </CreateMonitoringProfileRequestDetail>
      </mon:CreateMonitoringProfileRequest>
   </soapenv:Body>
</soapenv:Envelope>
Name Characteristics
CreateMonitoringProfileRequest Aggregate
CreateMonitoringProfileRequest @ServiceVersionNumber
CreateMonitoringProfileRequest @xsi:schemaLocation
CreateMonitoringProfileRequest. TransactionDetail Aggregate, Optional

Records information necessary to process this request.

CreateMonitoringProfileRequest. TransactionDetail. ApplicationTransactionID string, up to 64 chars, Optional

A number assigned by the calling application to uniquely identify this request.

CreateMonitoringProfileRequest. TransactionDetail. TransactionTimestamp dateTime, Optional

The date and time when this request was created. When the request is from an intermediary, such as a workflow manager or service bus, this is the date and time when the message was sent to the D&B function, i.e., the date and time when the xml document was created by the requesting intermediary.

CreateMonitoringProfileRequest. TransactionDetail. SubmittingOfficeID string, up to 64 chars, Optional

A number that identifies the system or the software application from where this request originated. / A number used to uniquely identfy the D&B business segment or delivery channel from where this request originated.

END: CreateMonitoringProfileRequest. TransactionDetail /Aggregate
CreateMonitoringProfileRequest. CreateMonitoringProfileRequestDetail Aggregate, Required

Records details of the request to create a profile, a set of events and their thresholds, used to monitor a DUNS or a set of DUNS.

CreateMonitoringProfileRequest. CreateMonitoringProfileRequestDetail. MonitoringProfileSpecification Aggregate, Required

Records the preferences provided by the Customer/User on the monitoring parameters while enrolling for the monitoring service.

CreateMonitoringProfileRequest. CreateMonitoringProfileRequestDetail. MonitoringProfileSpecification. MonitoringProfileName string, at least 1 char, up to 64 chars Pattern: {*[^\s]*}, Required

A name that is provided by the user to the profile.

CreateMonitoringProfileRequest. CreateMonitoringProfileRequestDetail. MonitoringProfileSpecification. MonitoringProfileDescription string, up to 256 chars, Optional

A string that records the description of the profile

CreateMonitoringProfileRequest. CreateMonitoringProfileRequestDetail. MonitoringProfileSpecification. DNBProductID string, up to 64 chars, Required

Records the product code that is provided by the customer to create a profile

CreateMonitoringProfileRequest. CreateMonitoringProfileRequestDetail. MonitoringProfileSpecification. MonitoringLevel MonitoringLevelTextEnum up to 16 chars, Required

A alphanumeric string which determines the level of details that the customer will receive during a change event

Possible values: Level1; Level2. Level2 provides change event notices along with a copy of the data layer; while Level1 only provides the notices.

CreateMonitoringProfileRequest. CreateMonitoringProfileRequestDetail. MonitoringProfileSpecification. MonitoringElementDetail Aggregate, Optional
CreateMonitoringProfileRequest. CreateMonitoringProfileRequestDetail. MonitoringProfileSpecification. MonitoringElementDetail. MonitoringElement Aggregate, Required (Infinite)
CreateMonitoringProfileRequest. CreateMonitoringProfileRequestDetail. MonitoringProfileSpecification. MonitoringElementDetail. MonitoringElement. PCMElementXPATHText string, up to 3000 chars, Required
CreateMonitoringProfileRequest. CreateMonitoringProfileRequestDetail. MonitoringProfileSpecification. MonitoringElementDetail. MonitoringElement. MonitoringChanges Aggregate, Required (Infinite)
CreateMonitoringProfileRequest. CreateMonitoringProfileRequestDetail. MonitoringProfileSpecification. MonitoringElementDetail. MonitoringElement. MonitoringChanges. ChangeCondition ChangeConditionEnum, Required

Possible values: AnyChange; ValueIncreaseByPercentage; ValueDecreaseByPercentage; ValueChangeByPercentage; ValueIncreaseBy; ValueDecreaseBy; ValueChangeBy; ValueGoesBeyond; ValueGoesBelow; ValueEquals; DateChangeBy; DateEquals

CreateMonitoringProfileRequest. CreateMonitoringProfileRequestDetail. MonitoringProfileSpecification. MonitoringElementDetail. MonitoringElement. MonitoringChanges. ChangeValue string, at least 1 char, up to 64 chars Pattern: {*[^\s]*}, Optional
END: CreateMonitoringProfileRequest. CreateMonitoringProfileRequestDetail. MonitoringProfileSpecification. MonitoringElementDetail. MonitoringElement. MonitoringChanges /Aggregate
END: CreateMonitoringProfileRequest. CreateMonitoringProfileRequestDetail. MonitoringProfileSpecification. MonitoringElementDetail. MonitoringElement /Aggregate
END: CreateMonitoringProfileRequest. CreateMonitoringProfileRequestDetail. MonitoringProfileSpecification. MonitoringElementDetail. MonitoringElement /Aggregate
CreateMonitoringProfileRequest. CreateMonitoringProfileRequestDetail. MonitoringProfileSpecification. MonitoringElementDetail. ReturnChangedDataOnlyIndicator boolean

When 'true' indicates that Change Notices will only include information for fields whose value has changed. When 'false' indicates that Change Notices will include information for all fields, regardless if the values have changed. The latter scenario applies when a whole data layer and/or aggregate is being monitored.

END: CreateMonitoringProfileRequest. CreateMonitoringProfileRequestDetail. MonitoringProfileSpecification /Aggregate
CreateMonitoringProfileRequest. CreateMonitoringProfileRequestDetail. InquiryReferenceText Aggregate, Optional

Records data that allows the customer to specify information to be linked to the request in order to support subsequent order reconciliation.

CreateMonitoringProfileRequest. CreateMonitoringProfileRequestDetail. InquiryReferenceText. CustomerReferenceText string, up to 240 chars, Optional (Up to 5x)

A freeform reference string provided by the customer to be linked to the product in order to support subsequent order reconciliation.

END: CreateMonitoringProfileRequest. CreateMonitoringProfileRequestDetail. InquiryReferenceText /Aggregate
END: CreateMonitoringProfileRequest. CreateMonitoringProfileRequestDetail /Aggregate
END: CreateMonitoringProfileRequest /Aggregate

Endpoint

Use the following endpoint with the downloadable WSDL to request this feature.

SOAP (Monitoring)
https://direct.dnb.com/Monitoring/V{version}

Testing

This operation will return a static set of results in the D&B Direct test environment (sandbox), regardless of the request parameters.

Feature Response

Specification

The following is a list of the possible data fields returned by this operation in the XML response. Samples are provided for testing successful and failed retrieval, and to demonstrate the basic layout of a response. The data returned in samples may not represent actual values that this feature will deliver.

A static change notice will be generated regardless of the conditions/values specified in test Monitoring Profiles.

NOTE: The D-U-N-S Number returned in the response will be a nine-digit zero-padded, numeric value.

Sample Response (Create)
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <mon:CreateMonitoringProfileResponse ServiceVersionNumber="4.0" xmlns:mon="http://services.dnb.com/MonitoringServiceV2.0">
         <TransactionDetail>
            <ServiceTransactionID>Id-b6ca05a7520e3db90fdb742e-1</ServiceTransactionID>
            <TransactionTimestamp>2013-08-16T10:56:57-04:00</TransactionTimestamp>
         </TransactionDetail>
         <TransactionResult>
            <SeverityText>Information</SeverityText>
            <ResultID>CM000</ResultID>
            <ResultText>Success</ResultText>
         </TransactionResult>
         <CreateMonitoringProfileResponseDetail>
            <MonitoringProfileDetail>
               <MonitoringProfileName>Monitor_DCP_PREM_Product</MonitoringProfileName>
               <MonitoringProfileID>1774</MonitoringProfileID>
            </MonitoringProfileDetail>
         </CreateMonitoringProfileResponseDetail>
      </mon:CreateMonitoringProfileResponse>
   </soapenv:Body>
</soapenv:Envelope>
Name Characteristics
CreateMonitoringProfileResponse Aggregate
CreateMonitoringProfileResponse@ServiceVersionNumber Attribute
CreateMonitoringProfileResponse@xsi:schemaLocation Attribute
CreateMonitoringProfileResponse. TransactionDetail Aggregate, Required

Records information necessary to process a particular request. Examples of a request is the ordering of a product.

CreateMonitoringProfileResponse. TransactionDetail. ApplicationTransactionID string up to 64 chars., Optional

A number assigned by the calling application to uniquely identify this request.

CreateMonitoringProfileResponse. TransactionDetail. ServiceTransactionID string up to 64 chars., Required

A number assigned by the D&B service to uniquely identify this transaction.

CreateMonitoringProfileResponse. TransactionDetail. TransactionTimestamp DateTimestamp, Required

The date and time when this request was submitted or the date and time when the requesting intermediary, such as a workflow manager or service bus, sent the message to the D&B function, i.e., the date and time when the xml document was created by the requesting intermediary.

END: CreateMonitoringProfileResponse. TransactionDetail /Aggregate
CreateMonitoringProfileResponse. TransactionResult Aggregate, Required

An aggregate that can repeat multiple times to record the different outcomes of the transaction.

CreateMonitoringProfileResponse. TransactionResult. SeverityText string up to 16 chars., Required

Text that records the criticality of the outcome, e.g., Information, Warning, Error, Fatal.

CreateMonitoringProfileResponse. TransactionResult. ResultID string up to 32 chars., Required

An alphanumeric string that uniquely identifies the outcome of the transaction.

CreateMonitoringProfileResponse. TransactionResult. ResultText string up to 512 chars., Optional

Text that explains the outcome of the transaction.

CreateMonitoringProfileResponse. TransactionResult. ResultMessage Aggregate, Optional (Infinite)

An aggregate that can repeat multiple times to record textual data that expands on the ResultID and ResultText to provide additional information to the user regarding the status of the transaction. If the status implies that there is a problem this may also provide guidance to the user on how to address it.

CreateMonitoringProfileResponse. TransactionResult. ResultMessage. ResultDescription string up to 512 chars., Required

Text that describes the additional information regarding the outcome of the transaction.

END: CreateMonitoringProfileResponse. TransactionResult. ResultMessage /Aggregate
END: CreateMonitoringProfileResponse. TransactionResult /Aggregate
CreateMonitoringProfileResponse. CreateMonitoringProfileResponseDetail Aggregate, Optional

Records the details of events and their thresholds, set to the profile to monitor a DUNS or a set of DUNS.

CreateMonitoringProfileResponse. CreateMonitoringProfileResponseDetail. MonitoringProfileDetail Aggregate, Required

Records the preferences set on the monitoring parameters enrolled for the monitoring service.

CreateMonitoringProfileResponse. CreateMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringProfileName string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Required

A name that is provided by the user to the profile.

CreateMonitoringProfileResponse. CreateMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringProfileID int, Required

A number that uniquely identifies a set of events and their thresholds, used to monitor a DUNS or a set of DUNS.

END: CreateMonitoringProfileResponse. CreateMonitoringProfileResponseDetail. MonitoringProfileDetail /Aggregate
CreateMonitoringProfileResponse. CreateMonitoringProfileResponseDetail. InquiryReferenceText Aggregate, Optional

Records data that allows the customer to specify information to be linked to the request in order to support subsequent order reconciliation.

CreateMonitoringProfileResponse. CreateMonitoringProfileResponseDetail. InquiryReferenceText. CustomerReferenceText string up to 240 chars., Optional(Up to 5x)

A freeform reference string provided by the customer to be linked to the product in order to support subsequent order reconciliation.

END: CreateMonitoringProfileResponse. CreateMonitoringProfileResponseDetail. InquiryReferenceText /Aggregate
END: CreateMonitoringProfileResponse. CreateMonitoringProfileResponseDetail /Aggregate
END: CreateMonitoringProfileResponse /Aggregate

NOTE: There may be additional request and/or response elements specified in the WSDL that are not applicable for D&B Direct customers. Data elements that are not listed on this page are currently unused by this operation.

Response Codes & Error Handling

Successful service requests will return a CM000 response code in the TransactionResult ResultID field. Otherwise, one of the D&B Direct standard response codes will be returned.

This operation may return the following response codes: CM001, CM002, CM004, CM007, CM014, CM023, SC001-SC009.

D&B Direct 2.0 API requests are provided on a metered basis; and may require entitlement prior to use in the production environment. In addition, a concurrency limit (QPS) is monitored to ensure that it is not exceeded. An error code will be returned in the event that a transaction is throttled.

While this operation is provided on a metered basis, usage is tracked; however, no billing for successful calls is recorded.

Operation-specific supplemental response code explanations:

Feature Notes

Here are some constraints of the <ChangeCondition> component in the Monitoring profile.

  • Profiles may only have a single change condition per element.
  • The default condition for any element is AnyChange
  • <ChangeValue> values should match the data type of the element being monitored

The following table highlights the condition options applicable for each data type:

Data type Supported change condition
String AnyChange
Numeric AnyChange
String ValueEquals
Numeric ValueEquals
Numeric ValueIncreaseByPercentage
Numeric ValueDecreaseByPercentage
Numeric ValueChangeByPercentage
Numeric ValueIncreaseBy
Numeric ValueDecreaseBy
Numeric ValueChangeBy
Numeric ValueGoesBeyond
Numeric ValueGoesBelow
Boolean AnyChange
Date AnyChange
Date DateChangeBy
Date DateEquals
EnumString AnyChange

What to do Next