Skip to main content
Version: 2.2.3

importPlanActivity

This method allows adding and editing:

  • Data from a verification, preventive maintenance, or calibration plan.

To insert each of these items, it is necessary to follow the standard documented below.

Java class
Requestweb\wwwroot\ws\java\asset\ImportPlanActivityRequestType.java
Returnweb\wwwroot\ws\java\asset\ImportPlanActivityRequestType.java

Request:

IDRequiredDescription
FGOPTIONXAction option:
21 - Add;
22 - Edit.
FGPLANTYPEX¹Plan type:
1 - Verification;
2 - Preventive maintenance;
3 - Calibration.
IDPLANACTIVITYXPlan ID #
NMPLANACTIVITYX¹Plan name
IDMODELACTIVITYX¹Standard activity ID #
FGPLANCONFX¹Plan configuration:
1 - Inherit activity data;
2 - Copy data from activity.
IDASSETX¹Asset ID #. For multiple assets, separate the identifiers with semicolons.
E.g.: IDASSET01;IDASSET02;IDASSET03
IDTEAMX¹ID # of the team responsible for the plan
IDTEAMPROGX²ID # of the team responsible for planning
IDTEAMEXECX²ID # of the team responsible for execution
FGDATEFREQUENCYDate-based frequency:
1 - Enable;
2 - Disable.
FGFREQTYPEX³Frequency type:
1 - Execution date;
2 - First use;
3 - Usage time.
QTFREQUENCEX³Frequency
FGFREQUNITX³Frequency unit:
1 - Day(s);
2 - Week(s);
3 - Month(s);
4 - Year(s);
5 - Working day(s).
FGDATEVIEWX³Date visualization:
1 - Month/Day/Year;
2 - Month/Year.
DTNEXTEXECUTIONX³Date of the next execution (format Y-m-d)
IDCALENDARCalendar ID #
FGMETERFREQUENCYFrequency based on asset meter:
1 - Enable;
2 - Disable.
VLMETERFREQUENCYX⁴Frequency
VLANTECIPATIONX⁴Anticipation
VLNEXTEXECUTIONX⁴Next execution
FGAUTOCREATECreate activity automatically:
1 - Enable;
2 - Disable.
FGAUTOSTATUSX⁵Activity step created automatically:
1 - Planning;
2 - To be started.
QTDAYBEFOREX⁵Number of days, in advance, for the automatic activity to be created
FGKEEPCREATINGX⁵Continue to create activities automatically even if there already are pending activities?
1 - Yes;
2 - No.
IDEVALMETHODX⁶Evaluation method ID #
DSEVALCRITX⁷For quantitative method:
▪For list of values: [id criterion 1]=[id result1];[id criterion 2]=[id result2]
▪For indeterminate value: [id criterion 1]=[value 1];[id criterion 2]=[value 2]
▪Mix: [id criterion 1]=[id result1];[id criterion 2]=[value 2]
For simple listing method:
▪[id result]
QTNOTIFYB4DAYNumber of days, in advance, for the notification, between 0 and 999.
info
  • X¹: Required for insertion.
  • X²: Required for insertion, if the plan configuration is of the copy type (FGPLANCONF = 2).
  • X³: Required if date-based frequency is enabled (FGDATEFREQUENCY = 1).
  • X⁴: Required if meter-based frequency is enabled (FGMETERFREQUENCY = 1).
  • X⁵: Required if the option to create an activity automatically is enabled (FGAUTOCREATE = 1).
  • X⁶: Required if the DSEVALCRIT field is filled in.
  • X⁷: Required if the IDEVALMETHOD field is filled in.

Request structure:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:asset">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:importPlanActivity>
         <!--You may enter the following 28 items in any order-->
         <urn:fgoption>?</urn:fgoption>
         <urn:fgplantype>?</urn:fgplantype>
         <urn:idplanactivity>?</urn:idplanactivity>
         <urn:nmplanactivity>?</urn:nmplanactivity>
         <urn:idmodelactivity>?</urn:idmodelactivity>
         <urn:fgplanconf>?</urn:fgplanconf>
         <urn:idasset>?</urn:idasset>
         <urn:idteam>?</urn:idteam>
         <urn:idteamprog>?</urn:idteamprog>
         <urn:idteamexec>?</urn:idteamexec>
         <urn:fgdatefrequency>?</urn:fgdatefrequency>
         <urn:fgfreqtype>?</urn:fgfreqtype>
         <urn:qtfrequence>?</urn:qtfrequence>
         <urn:fgfrequnit>?</urn:fgfrequnit>
         <urn:fgdateview>?</urn:fgdateview>
         <urn:dtnextexecution>?</urn:dtnextexecution>
         <urn:idcalendar>?</urn:idcalendar>
         <urn:fgmeterfrequency>?</urn:fgmeterfrequency>
         <urn:vlmeterfrequency>?</urn:vlmeterfrequency>
         <urn:vlantecipation>?</urn:vlantecipation>
         <urn:vlnextexecution>?</urn:vlnextexecution>
         <urn:fgautocreate>?</urn:fgautocreate>
         <urn:fgautostatus>?</urn:fgautostatus>
         <urn:qtdaybefore>?</urn:qtdaybefore>
         <urn:fgkeepcreating>?</urn:fgkeepcreating>
         <urn:idevalmethod>?</urn:idevalmethod>
         <urn:dsevalcrit>?</urn:dsevalcrit>
         <urn:qtnotifyb4day>?</urn:qtnotifyb4day>
      </urn:importPlanActivity>
   </soapenv:Body>
</soapenv:Envelope>

Return:

IDDescription
returnSUCCESS: 1.
FAILURE: Returns a message regarding the error that occurred
Last updated on