Difference between revisions of "Agility Web Services"

From Agility
Jump to: navigation, search
(→‎WorkPlannerData)
(→‎WorkPlannerData)
Line 22: Line 22:
 
             <gen:password>PASSWORD</gen:password>
 
             <gen:password>PASSWORD</gen:password>
 
         </gen:LoginService>
 
         </gen:LoginService>
−
         <gen:startDate>2015-01-01</gen:startDate>
+
         <gen:startDate>2015-07-07</gen:startDate>
−
         <gen:endDate>2015-12-31</gen:endDate>
+
         <gen:endDate>2015-07-07</gen:endDate>
 
         <!--Optional:-->
 
         <!--Optional:-->
 
         <gen:reportType>Week</gen:reportType>
 
         <gen:reportType>Week</gen:reportType>
 
         <gen:includeStdJobs>false</gen:includeStdJobs>
 
         <gen:includeStdJobs>false</gen:includeStdJobs>
−
         <gen:includeOpenWorkOrders>false</gen:includeOpenWorkOrders>
+
         <gen:includeOpenWorkOrders>true</gen:includeOpenWorkOrders>
−
         <gen:includeCompletedWorkOrders>true</gen:includeCompletedWorkOrders>
+
         <gen:includeCompletedWorkOrders>false</gen:includeCompletedWorkOrders>
 
         <!--Optional:-->
 
         <!--Optional:-->
−
         <gen:ppmFilterExpression>maxresults -1</gen:ppmFilterExpression>
+
         <gen:filterExpression>maxresults -1</gen:filterExpression>
 
         <!--Optional:-->
 
         <!--Optional:-->
−
         <gen:jobsFilterExpression>maxresults -1</gen:jobsFilterExpression>
+
         <gen:startAsset>a</gen:startAsset>
−
         <gen:extendedData>true</gen:extendedData>
+
        <!--Optional:-->
−
         <gen:useCachedItems>false</gen:useCachedItems>
+
         <gen:endAsset>z</gen:endAsset>
 +
        <!--Optional:-->
 +
         <gen:craftCode>Elec</gen:craftCode>
 
       </gen:WorkPlannerData>
 
       </gen:WorkPlannerData>
 
   </soap:Body>
 
   </soap:Body>
Line 57: Line 59:
 
;<pre><gen:includeCompletedWorkOrders></pre>
 
;<pre><gen:includeCompletedWorkOrders></pre>
 
:If the parameter is set to ''true'' Completed Work Orders will be included in the data
 
:If the parameter is set to ''true'' Completed Work Orders will be included in the data
−
;<pre><gen:ppmFilterExpression></pre>
+
;<pre><gen:filterExpression></pre>
−
:Filter Expression string describing filtering criteria that need to be applied for PPM-related information
+
:Filter Expression string describing additional filtering criteria that need to be applied for PPM-related or Work Order-related information
−
;<pre><gen:jobsFilterExpression></pre>
+
;<pre><gen:startAsset></pre>
−
: Filter expression string describing filtering criteria that need to be applied for Work Order-related information.
+
: Asset code to specify the beginning of the range of assets which are going to be included in the returned data.
−
;<pre><gen:extendedData></pre>
+
;<pre><gen:endAsset></pre>
−
:Full set of attributes will be produced as the output of the report if the option is set to true. Only basic set of attributes will be produced otherwise.
+
: Asset code to specify the end of the range of assets which are going to be included in the returned data.
−
;<pre><gen:useCachedItems></pre>
+
;<pre><gen:craftCode></pre>
−
: Option can be used to speed up data generation process. It instructs the system to use cached calculations if they exist as the result of the previous call to the Web Service within the same session.
+
: Code of the craft to restrict the returned data to. IF anything specified, only records which relates to a specified craft will be returned. If nothing is specified, data related to any craft will be returned
  
 
More information can be found in [[Raports#Work_Schedule_Planner|Work Schedule Planner report]]
 
More information can be found in [[Raports#Work_Schedule_Planner|Work Schedule Planner report]]

Revision as of 10:47, 7 June 2016

This section itemizes Agility Web Services, which can be used to export or import data into Agility. All available options are described in sections below.

WorkPlannerData

Web Service provided to allow getting data which are used to produced Work Planner Report in Agility. Detailed description of the web service can be found at:

Web Services Definitions page under WorkPlannerData item.

Sample XML Message

Below is the sample xml which can be passed to the WorkPlannerData web service: 

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:gen="http://www.fastnetasp.com/GeneralImport">
   <soap:Header/>
   <soap:Body>
      <gen:WorkPlannerData>
         <!--Optional:-->
         <gen:LoginService>
            <!--Optional:-->
            <gen:login>LOGIN_NAME</gen:login>
            <!--Optional:-->
            <gen:password>PASSWORD</gen:password>
         </gen:LoginService>
         <gen:startDate>2015-07-07</gen:startDate>
         <gen:endDate>2015-07-07</gen:endDate>
         <!--Optional:-->
         <gen:reportType>Week</gen:reportType>
         <gen:includeStdJobs>false</gen:includeStdJobs>
         <gen:includeOpenWorkOrders>true</gen:includeOpenWorkOrders>
         <gen:includeCompletedWorkOrders>false</gen:includeCompletedWorkOrders>
         <!--Optional:-->
         <gen:filterExpression>maxresults -1</gen:filterExpression>
         <!--Optional:-->
         <gen:startAsset>a</gen:startAsset>
         <!--Optional:-->
         <gen:endAsset>z</gen:endAsset>
         <!--Optional:-->
         <gen:craftCode>Elec</gen:craftCode>
      </gen:WorkPlannerData>
   </soap:Body>
</soap:Envelope>

Parameters description

<gen:login>
Agility valid Login name 
<gen:password>
valid password for the login name entered
<gen:startDade>
Beginning of the time frame to generate the data for
<gen:endDate>
End of the time frame to generate the data for
<gen:reportType>
One of the options Day,Week,Month specifying the level of granularity for the data to generate
<gen:includeStdJobs>
If the parameter is set to true, Work Orders which are due to be generated based on the PPM definition will be included in the data
<gen:includeOpenWorkOrders>
If the parameter is set to true Open Work Orders will be include in the data
<gen:includeCompletedWorkOrders>
If the parameter is set to true Completed Work Orders will be included in the data
<gen:filterExpression>
Filter Expression string describing additional filtering criteria that need to be applied for PPM-related or Work Order-related information
<gen:startAsset>
Asset code to specify the beginning of the range of assets which are going to be included in the returned data.
<gen:endAsset>
Asset code to specify the end of the range of assets which are going to be included in the returned data.
<gen:craftCode>
Code of the craft to restrict the returned data to. IF anything specified, only records which relates to a specified craft will be returned. If nothing is specified, data related to any craft will be returned

More information can be found in Work Schedule Planner report

Retrieved from "http://agilitywiki.northeurope.cloudapp.azure.com/agilitywiki/index.php?title=Agility_Web_Services&oldid=355"