Availability

ComTrade.EMC.Documentum.xPloreIndexServer.Windows.ContentProcessingService.Availability (UnitMonitor)

Monitors Documentum Content Processing Service availability.

Knowledge Base article:

Summary

This monitor checks whether the xPlore Content Processing Service's URL is available. It detects if xPlore Content Processing Service's URL cannot be accessed.

There are several types of xPlore Instance: Search/Indexing, CPS (Content Processing) and Index Agent.

CPS Instance is a Content Processing Instance. This Instance is used to extract indexable content from documents and to parse it to tokens which are later used to build full-text indexes.

If CPS Instance is not available, the documents will not be indexed.

Configuration

The following configuration parameters are customizable:

IntervalSeconds - the monitoring period for checking availability of CPS's URL (the default interval is set to 5 minutes)
SyncTime - The synchronization time specified by using a 24-hour format. No default value specified

Causes

There can be several reasons for xPlore CPS Instance to be not available. Most of them are network related, like port already in use, firewall settings don't allow connection to the Instance URL, and other.

Resolutions

Not Available

Check the xPlore CPS Instance status. If it's running then there are problems with connection to the xPlore URL. Check the xPlore CPS log files for errors during startup. Also check Firewall settings.

Element properties:

Target

ComTrade.EMC.Documentum.Windows.ContentProcessingService

Parent Monitor

System.Health.AvailabilityState

Category

AvailabilityHealth

Enabled

True

Alert Generate

True

Alert Severity

MatchMonitorHealth

Alert Priority

Normal

Alert Auto Resolve

True

Monitor Type

ComTrade.EMC.Documentum.xPloreIndexServer.Windows.ContentProcessingService.2State.MonitorType

Remotable

True

Accessibility

Public

Alert Message

Documentum Content Processing Service Availability Monitor

Following content processing service not available:

Content Processing Service Name: {0}
Hostame: {1}
Port: {2}

Availability Status: {3}

RunAs

Default

Source Code:

<UnitMonitor ID="ComTrade.EMC.Documentum.xPloreIndexServer.Windows.ContentProcessingService.Availability" Accessibility="Public" Enabled="true" Target="CTDmWinDisc!ComTrade.EMC.Documentum.Windows.ContentProcessingService" ParentMonitorID="Health!System.Health.AvailabilityState" Remotable="true" Priority="Normal" TypeID="ComTrade.EMC.Documentum.xPloreIndexServer.Windows.ContentProcessingService.2State.MonitorType" ConfirmDelivery="true">

  <Category>AvailabilityHealth</Category>

  <AlertSettings AlertMessage="ComTrade.EMC.Documentum.xPloreIndexServer.Windows.ContentProcessingService.Availability_AlertMessageResourceID">

    <AlertOnState>Error</AlertOnState>

    <AutoResolve>true</AutoResolve>

    <AlertPriority>Normal</AlertPriority>

    <AlertSeverity>MatchMonitorHealth</AlertSeverity>

    <AlertParameters>

      <AlertParameter1>$Target/Property[Type="CTDmLib!ComTrade.EMC.Documentum.ContentProcessingService"]/Name$</AlertParameter1>

      <AlertParameter2>$Target/Property[Type="CTDmLib!ComTrade.EMC.Documentum.ContentProcessingService"]/Hostname$</AlertParameter2>

      <AlertParameter3>$Target/Property[Type="CTDmLib!ComTrade.EMC.Documentum.ContentProcessingService"]/Port$</AlertParameter3>

      <AlertParameter4>$Data/Context/Property[@Name='Availability']$</AlertParameter4>

    </AlertParameters>

  </AlertSettings>

  <OperationalStates>

    <OperationalState ID="UIGeneratedOpStateIdContentProcessingServiceAvailabilityNormal" MonitorTypeStateID="NormalState" HealthState="Success"/>

    <OperationalState ID="UIGeneratedOpStateIdContentProcessingServiceAvailabilityOther" MonitorTypeStateID="OtherState" HealthState="Error"/>

  </OperationalStates>

  <Configuration>

    <IntervalSeconds>300</IntervalSeconds>

    <SyncTime/>

    <Name>$Target/Property[Type="CTDmLib!ComTrade.EMC.Documentum.ContentProcessingService"]/Name$</Name>

    <DeployPath>$Target/Property[Type="CTDmLib!ComTrade.EMC.Documentum.ContentProcessingService"]/DeploymentPath$</DeployPath>

    <ExpressionNormal>

      <SimpleExpression>

        <ValueExpression>

          <XPathQuery Type="String">Property[@Name="Availability"]</XPathQuery>

        </ValueExpression>

        <Operator>Equal</Operator>

        <ValueExpression>

          <Value Type="String">Available</Value>

        </ValueExpression>

      </SimpleExpression>

    </ExpressionNormal>

    <ExpressionOther>

      <SimpleExpression>

        <ValueExpression>

          <XPathQuery Type="String">Property[@Name="Availability"]</XPathQuery>

        </ValueExpression>

        <Operator>NotEqual</Operator>

        <ValueExpression>

          <Value Type="String">Available</Value>

        </ValueExpression>

      </SimpleExpression>

    </ExpressionOther>

    <TargetComputer>$Target/Host/Host/Property[Type="Windows!Microsoft.Windows.Computer"]/NetworkName$</TargetComputer>

  </Configuration>

</UnitMonitor>