Package psdi.app.pm

The PM package contains Mbos related to preventive maintenance.

See: Description

  • Interface Summary 
    Interface Description
    PMAncestorRemote
    Remote Interface to the PMAncestor object.
    PMAncestorSetRemote
    Remote Interface to the set of PMAncestors.
    PMForecastJPRemote
    Remote interface to the PMForecastJP object.
    PMForecastJPSetRemote
    Remote interface to the PMForecastJPSet object.
    PMForecastRemote
    Remote interface to the PMForecast object.
    PMForecastSetRemote
    Remote interface to the PMForecastSet object.
    PMMeterRemote
    Remote Interface to the PMMeter object.
    PMMeterSetRemote
    Remote Interface to the set of PMMeter.
    PMRemote
    Remote Interface to the PM object.
    PMSeasonsRemote
    Remote Interface to the PMSeasons object.
    PMSeasonsSetRemote
    Remote Interface to the set of PMSeasons.
    PMSequenceRemote
    Remote Interface to the PMSequence object.
    PMSequenceSetRemote
    Remote Interface to the set of PMSequence.
    PMServiceRemote
    Remote Interface to the PMService object.
    PMSetRemote
    Remote Interface to the set of PMs.
    WogenRemote
    Remote Interface to the Wogen object.
    WogenSetRemote
    Remote Interface to the set of Wogens.
  • Class Summary 
    Class Description
    FldDJPPMMeasure  
    FldDJPPMSequenceTotalWorkUnits  
    FldErlstWoGenDate
    Behavior of the ErlstWoGenDate field in the PM object.
    FldMasterPM
    Behaviour of the MasterPM field in the PM object
    FldOverrideMasterUpd
    Behaviour of the overridemasterupd field in the PM object
    FldPMActMeter
    Behaviour of the PMActMeter field in the PM object
    FldPMAdjNextDue
    Behaviour of the adjnextdue field in the PM object
    FldPMAlertLead
    Behaviour of the AlertLead field in the PM object
    FldPMAssetFeatureId
    Behaviour of the AssetfeatureId field in the PM object
    FldPMAssetnum
    Behaviour of the Assetnum field in the PM object
    For any given PM, either a 'asset' or 'location' can be entered.
    FldPMAssetWogen
    Behaviour of the AssetWogen field in the PM object
    FldPMAsync  
    FldPMChild
    Attribute handler for the pmnum attribute of PM.
    FldPMCount
    Behaviour of the pmcount field in the PM object.
    FldPMCounter
    Behaviour of the pmcounter field in the PM object
    The pmcounter represents the number of work orders that the PM has generated.
    FldPMDayOfWeek
    Behaviour of the Day of Week fields Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday in the PM object
    FldPMExtdate
    Behaviour of the extdate field in the PM object Extdate is the extended time used to do a one-time extension of a PM's next due date.
    FldPMFeature
    Behaviour of the feature field in the PM object
    FldPMFirstdate
    Behaviour of the firstdate field in the PM object
    First date is the date when work orders will be generated from PM.
    FldPMForecastExists  
    FldPMForecastJPNum
    Behaviour of the non persistent field JPNum in the PMForecast object
    FldPMForecastLTDPMCounter
    Behaviour of the LTDPMCounter field in the PMForecast object Represents the number of work orders that the PM has generated.
    FldPMForecastNewDate
    Behavior of the NewDate field in the PMForecast object
    FldPMFrequency
    Behaviour of the Frequency field in the PM object
    The 'Frequency' represents the number of time units to elapse between the workorders generated from PM.
    FldPMFreqUnit
    Behaviour of the Frequnit field in the PM object
    Frequency Units Represents the time units that is elapsed between the work orders generated from PM.
    FldPMGLAccount
    Behaviour of the GLACCOUNT field in the PM object
    If a PM is not a master Pm, then it should have either asset, or location or GLAccount associated with it.
    FldPMGroupOwner
    Validation class for the PM.GroupOwner field
    FldPMInclForecast  
    FldPMJpnum
    Behaviour of the job plan field in the PM object
    The job plan is used to generate the work order
    FldPMJpSeqInUse
    Behaviour of the 'jpseqinuse' field in the PM object
    Indicates whether the PM uses a jobplan sequence for work order generation or not.
    FldPMLastForecastDate
    Behaviour of the LastForecastDate field in the PM object This is a nonpersistent field, stores the last forecasted date of the PM
    FldPMLead
    Common Class Validation for the key column Lead
    FldPMLeadTimeActive
    Behaviour of the non-persistant field 'LEADTIMEACTIVE' in the PM object
    'LeadtimeActive' attribute indicates whether Lead Time is used on a PM record to generate a work order in advance of when it is due.
    FldPMLocation
    Behaviour of the location field in the PM object
    For a PM, either a 'asset' or 'location' can be entered.
    FldPMLockForecast  
    FldPMLRM
    The field class for LRM field in the PM object.
    FldPMLTDPMCounter  
    FldPMMeterAlertLead
    Behaviour of the AlertLead field in the PMMeter object
    FldPMMeterAverage
    Behaviour of the Average field in the PMMeter object
    FldPMMeterDateOfNextWo
    Behavior of the DateOfNextWo field in the PMMeter object.
    FldPMMeterFreq
    Behaviour of the frequency field in the PMMeter object
    FldPMMeterLastPmWogenRead
    Behaviour of the LastPMWogenRead field in the PMMETER object
    FldPMMeterLastPmWogenReadDt
    Behaviour of the LastPMWogenReadDt field in the PMMETER object
    FldPMMeterMeterName
    Behaviour of the MeterName field in the PMMeter object
    FldPMMeterRollOver
    Behaviour of the rollover field in the PMMeter object
    FldPMMeterTolerance
    Behaviour of the Tolerance field in the PMMeter object
    FldPMMeterUnitsToGo
    Behaviour of the non-persistant field 'UnitsToGo' in the PMMeter object
    FldPMNextdate
    Behaviour of the nextdate field in the PM object
    Next date is the Time based date when work orders will be generated from PM.
    FldPMNum
    Common Validation Class for: Preventive Maintenance identifiers - pmnum.
    The constructor takes a name of a PM criteria - as defined in PMService.initCriteriaList.
    FldPMOwner
    Validation class for the PM.Owner field
    FldPMParent
    Behaviour of the parent field in the PM object
    FldPMPersonGroup
    Common Class Validation for the key column PersonGroup
    FldPMRepairFacility
    Behaviour of the repair facility field in the PM object
    Represents the repair facility location.
    FldPMRoute
    Behaviour of the route field in the PM object
    Routes cannot be associated with a PM that has 'children' or one cannot add child/children to a PM if it is associated with a 'route'
    FldPMSchedEarly  
    FldPMSeasonEndDay
    Behaviour of the seasonendday field in the PM object
    Represents the end day of PM's active season dates.
    FldPMSeasonsEndMonth
    Behaviour of the End Month field in the PMSeasons object
    FldPMSeasonsStartMonth
    Behaviour of the Start Month field in the PMSeasons object
    FldPMSeasonStrDay
    Behaviour of the season startday field in the PM object
    Represents the start day of PM's active season dates.
    FldPMSeqInterval
    Behaviour of the 'interval' field in the PMSEQUENCE object
    Duplicate intervals are not allowed in a jobplan sequence set.
    FldPMSeqJpnum
    Behaviour of the job plan field in the PMSEQUENCE object
    The job plan is used when work order is generated for this PM.
    FldPMStoreloc
    Behaviour of the storeroom location field in the PM object
    FldPMStoreLocSite
    Common Validation Class for: StoreLocSite
    FldPMUseAssetDefRepFac
    Behaviour of the Use Asset's Default Repair Facility field in the PM object
    FldPMUseFrequency
    Behaviour of the 'UseFrequency' field in the PM object 'UseFrequency' indicates whether user can generate workorders for the PM heirarchy when this PM's Frequency crieteria are met.
    FldPMUseTargetDate
    Behaviour of the usetargetdate field in the PM object
    Boolean field that indicates which date begins the PM Frequency Count.
    FldPMWoSequence
    Behaviour of the wosequence field in the PM object
    FldPMWoStatus
    Behaviour of the wostatus field in the PM object
    FldWorkType
    Common Validation Class for: WorkType This class uses the error key NotValidWorkType from the workorder message file.
    PM
    MBO to represent PM.
    PMAncestor
    Mbo object to represent PMAncestor.
    PMAncestorSet
    Represents the set of PMAncestor records.
    PMForecast
    MBO object to represent PMForecast.
    PMForecastCostCronTask
    This is a Cron task that generates PM Forecast Cost in the background.
    PMForecastCronTask
    This is a Cron task that generates PM Forecast.
    PMForecastJP
    MBO object to represent PMForecastJP.
    PMForecastJPSet
    Represents the set of PMForecastJP
    PMForecastSet
    Represents the set of PMForecast
    PMListener
    This object is created to respond to all events where a PM has a change which needs to be reflected in the PMAncestor table.
    PMMeter
    MBO object to represent PMMeter.
    PMMeterSet
    Represents the set of PMMeters.
    PMSeasons
    MBO object to represent PMSeasons.
    PMSeasonsSet
    Represents the set of PMSeasons.
    PMSequence
    MBO object to represent PMSequence.
    PMSequenceSet
    Represents the set of PMSequence.
    PMService
    PMService class handles the classes in the PM package
    PMSet
    Represents a set of PMs.
    PMStatusHandler
    Handles all the status changes for a PM object
    PMWoGenCronTask
    This is a Cron task that generates workoders from PMs.
    Wogen
    Mbo object to represent Wogen.
    WogenSet
    Represents the set of Wogen records.

Package psdi.app.pm Description

The PM package contains Mbos related to preventive maintenance. PM records are templates that contain job plan and scheduling information for a piece of equipment or location. A PM record specifies work to be performed regularly based on elapsed time or on meter readings. PM records can be defined against a piece of equipment or a location, but not both. When it is time for preventive maintenance work to occur, work orders are generated. A PM record can generate a work order with a job plan also. Also a sequence of job plans can be defined for the PM (PMSequence). Master PM records are templates for other PM records. Master PM records can be used to create Associated PM records for equipment or locations which share common features. The scheduling information on Master PM record is used to update the associated PM records. A Master PM record cannot generate work orders, but the associated PM records can. The non-Master PM records can be organized into PM hierarchies which can generate corresponding work order hierarchies.

Package Specification

The MBOs included in the PM package are:

  • PM -- The main class and also the owner of other MBOs in this package. The equipments or locations require maintenance in order to keep high efficiency and prevent against breakdowns. PM records can be used to generate work orders that can do the maintenance work on a piece of equipment or location. A PM record specifies work to be performed. A PM record can have a job plan which will be copied to the work order that gets generated from a PM. A Master PM is a template that can be used to create associated PM records. Master PM records cannot be a part of hierarchy. The PM records can be organized into PM hierarchies. A single PM record cannot be a part of multiple hierarchies. 
  • PMAncestor -- PM records may be organized into hierarchies and this class is used to lookup relationships, but not to maintain them. A PM ancestor records allow quick look up of ancestors or descendants. The PMAncestor.HierarchyLevels attribute indicates the level of relationship between the ancestors or descendants. At the '0' (zeroth) hierarchy level every PM is related to itself. When a PM is parent of another PM, the hierarchy level is 1. Grandparent relationships are the 2nd level, great grandparent relationship are the 3rd level, and so on.
  • PMSequence -- PM records may have multiple Job Plans defined to include on the work orders they generate. A PMSequence is a list of job plans or a single job plan that can be used by the work orders generated from PM. If there is more than one job plan listed, the PM.pmcounter and the PMSequence.interval values will determine which job plan to be used and is updated every time when a new pmsequence record is added. The PM uses the job plan with smallest interval that divides evenly into the value in the pmcounter. If no interval divides evenly into the value  in the pmcounter, PM uses the primary job plan (with interval '1'). 

    Following Example shows the list of job plans with different intervals and in what order they will be used by PM while generating the work orders.

      JPNUM INTERVAL 
      JP1000
      JP3000
      JP5000
      JP7000

    The following table shows the order in which the job plans will be used by the PM for work order generation. 

      PMCOUNTER JPNUM INTERVAL 
      0 JP1000 1
      1 JP3000
      2 JP5000
      3 JP3000
      4 JP7000
      5 JP5000
      6 JP1000
      7 JP3000

  • Wogen -- This table is used to store work order information generated by the PM calculateWork method instead of creating work orders.

Other classes included in the PM package are:

  • PMService -- Service class for the package.

Related Documentation


Last updated: Thursday, January 24, 2002