CreateMonitoringProfile (SOAP)

This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.

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.

Authentication, Endpoint & WSDL

D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) is determined by the credentials submitted with each API request. Refer to the service page for the correct version of the operation.

Endpoint
https://maxcvservices.dnb.com/Monitoring/V{version} WSDL

Request Parameters

The following parameters are accepted by this operation. Please refer to the list of products that may be included in the Monitoring process.

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.

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

The Monitoring process triggers events based on the old and new data field values WHEN A CHANGE OCCURS, and is not based on the data layer values when the Monitoring Registration was created. To capture cumulative but gradual changes, using the "ValueGoesBeyond" or "ValueGoesBelow" conditions is recommended.

Developers may now add entries to Monitoring Profiles that specify the combination(s) of XPATH + attribute that they wish to Monitor. This is accomplished by appending an attribute statement to the XPATH within the CreateMonitoringProfile request. The statement may include multiple values for the attribute by using an OR ("||") operator.

<MonitoringElement>
  <PCMElementXPATHText>//Organization/Events/LegalEvents/OtherLegalEventInformation/OtherLegalEvent[FilingTypeText@DNBCodeValue=8035]</PCMElementXPATHText>
  <MonitoringChanges>
    <ChangeCondition>AnyChange</ChangeCondition>
    <ChangeValue>10</ChangeValue>
  </MonitoringChanges>
</MonitoringElement>
                  
<MonitoringElement>
  <PCMElementXPATHText>//Organization/Events/SignificantEvents/SpecialEvent[EventSubTypeText@DNBCodeValue=12317 || EventSubTypeText@DNBCodeValue=15378 || EventTypeText@DNBCodeValue=28227 || EventSubTypeText@DNBCodeValue=4073]</PCMElementXPATHText>
  <MonitoringChanges>
    <ChangeCondition>AnyChange</ChangeCondition>
    <ChangeValue>10</ChangeValue>
  </MonitoringChanges>
</MonitoringElement>

NOTE: The combination of attributes may NOT contain duplicate references to the same attribute.

Name Characteristics
CreateMonitoringProfileRequest Aggregate
CreateMonitoringProfileRequest@ServiceVersionNumber Attribute
CreateMonitoringProfileRequest@xsi:schemaLocation Attribute
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 DateTimestamp, 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 chars. 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 chars. 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 /Aggregate
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

Sample Request

<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="3.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>

Testing / Sandbox

This operation has no additional limits or restrictions in the D&B Direct sandbox (test) environment.

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

Response Specification

The following is a list of the possible data fields returned by this operation in the XML response.

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

Language/Character Sets

The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including the D&B Business Information Report (BIR), provide additional language options. Data layers are encoded using the ISO 8859-1 character set standard (also known as Latin-1).

Response Codes

Successful service requests will return a CM000 response code. 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.

Operation-specific supplemental response code explanations:

CM001 Blank value passed for PCMElementXpath
CM002 Any schema validation failure (e.g. elements that are mandatory in the schema are not present in the request, Sequence of the element is not matching in the schema, Data type mismatch or Invalid notification Level).
CM007

PCMElementXpath does not belong to the Product; or Invalid Change Value (Alert threshold)

CM014 Product Not available
CM023 Duplicate Profile Name

Samples (Download)

Request and response samples are available for this D&B Direct web services. The samples may cover a variety of scenarios (when applicable) and are designed for use in the test environment.

Monitoring Service
Samples http://developer.dnb.com/docs/2.0/monitoring/3.0/DnB-Monitoring.zip

Related Topics

UpdateMonitoringProfile (SOAP), ListMonitoringProfile (SOAP), Available Products.

Back to Top