Process Employees

1 Minute to read

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Used to process employees automatically when you load multiple employees by API.

The Auto Process field is included in the Employee Load API definition. If the Auto Process field is set to Yes, then the processing is complete. If you set the Auto Process field to No, then the employee processing is not completed.

Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.Planful.com/API/SOAP/StateFree/Common/2009/03/19">
<soapenv:Header/>
<soapenv:Body>
<ns:LoadEmployees>
<!--Optional:-->
<ns:LoginName>?</ns:LoginName>
<!--Optional:-->
<ns:Password>?</ns:Password>
<!--Optional:-->
<ns:TenantCode>?</ns:TenantCode>
<!--Optional:-->
<ns:employees1>
<!--Zero or more repetitions:-->
<ns:EmployeePosition>
<!--Optional:-->
<ns:EmployeeInfo>
<!--Optional:-->
<ns:ScenarioCode>?</ns:ScenarioCode>
<!--Optional:-->
<ns:HomeBudgetEntityCode>?</ns:HomeBudgetEntityCode>
<!--Optional:-->
<ns:Number>?</ns:Number>
<!--Optional:-->
<ns:Name>?</ns:Name>
<ns:HireDate>?</ns:HireDate>
</ns:EmployeeInfo>
<!--Optional:-->
<ns:PositionName>?</ns:PositionName>
<!--Optional:-->
<ns:PositionEntityCode>?</ns:PositionEntityCode>
<!--Optional:-->
<ns:OtherSegmentCodes>
<!--Zero or more repetitions:-->
<ns:KeyValues>
<!--Optional:-->
<ns:Key>?</ns:Key>
<!--Optional:-->
<ns:Value>?</ns:Value>
</ns:KeyValues>
</ns:OtherSegmentCodes>
<!--Optional:-->
<ns:EmployeeTypeCode>?</ns:EmployeeTypeCode>
<!--Optional:-->
<ns:PayPlanCode>?</ns:PayPlanCode>
<!--Optional:-->
<ns:WageType>?</ns:WageType>
<ns:RateperHour>?</ns:RateperHour>
<ns:WorkHours>?</ns:WorkHours>
<ns:Salary>?</ns:Salary>
<ns:FromDate>?</ns:FromDate>
<ns:TerminationDate>?</ns:TerminationDate>
<!--Optional:-->
<ns:reviewType>?</ns:reviewType>
<ns:NextReviewDate>?</ns:NextReviewDate>
<!--Optional:-->
<ns:Attribute>
<!--Zero or more repetitions:-->
<ns:KeyValues>
<!--Optional:-->
<ns:Key>?</ns:Key>
<!--Optional:-->
<ns:Value>?</ns:Value>
</ns:KeyValues>
</ns:Attribute>
<!--Optional:-->
<ns:CompensationItem>
<!--Zero or more repetitions:-->
<ns:KeyValues>
<!--Optional:-->
<ns:Key>?</ns:Key>
<!--Optional:-->
<ns:Value>?</ns:Value>
</ns:KeyValues>
</ns:CompensationItem>
<ns:BudgetReviewPercentage>?</ns:BudgetReviewPercentage>
<ns:CurrentReviewPercentage>?</ns:CurrentReviewPercentage>
<!--Optional:-->
<ns:BudgetRaiseMultiple>
<!--Zero or more repetitions:-->
<ns:APIBudgetReviews>
<ns:Date>?</ns:Date>
<ns:Percentage>?</ns:Percentage>
</ns:APIBudgetReviews>
</ns:BudgetRaiseMultiple>
<!--Optional:-->
<ns:notes>?</ns:notes>
</ns:EmployeePosition>
</ns:employees1>
<ns:payRollUploadDate>?</ns:payRollUploadDate>
<ns:AutoProcess>?</ns:AutoProcess>
</ns:LoadEmployees>
</soapenv:Body>
</soapenv:Envelope>

Example

In the example below, AutoProcess is set to Yes (<ns:AutoProcess>yes</ns:AutoProcess>).

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/ [schemas.xmlsoap.org]" xmlns:ns="http://www.Planful.com/API/SOAP/StateFree/Common/2009/03/19">
<soapenv:Header/>
<soapenv:Body>
	<ns:LoadEmployees>
	<!--Optional:-->
	<ns:LoginName>hchamarthi@planful.com</ns:LoginName>
	<!--Optional:-->
	<ns:Password>Wfp@1234</ns:Password>
	<!--Optional:-->
	<ns:TenantCode>WFPOnetimeGFNew</ns:TenantCode>
	<!--Optional:-->
	<ns:employees1>
	<!--Zero or more repetitions:-->
	<ns:EmployeePosition>
		<!--Optional:-->
		<ns:EmployeeInfo>
			<!--Optional:-->
			<ns:ScenarioCode>EUB_Budget2018</ns:ScenarioCode>
			<!--Optional:-->
			<ns:HomeBudgetEntityCode>45</ns:HomeBudgetEntityCode>
			<!--Optional:-->
			<ns:Number>Planful2000</ns:Number>
			<!--Optional:-->
			<ns:Name>HA2000</ns:Name>
			<ns:HireDate>2017-12-12</ns:HireDate>
		</ns:EmployeeInfo>
		<!--Optional:-->
		<ns:PositionName>HA2000</ns:PositionName>
		<!--Optional:-->
		<ns:PositionEntityCode>leaf</ns:PositionEntityCode>
		<!--Optional:-->
		<ns:OtherSegmentCodes>
			<!--Zero or more repetitions:-->
			<ns:KeyValues>
				<!--Optional:-->
				<ns:Key>?</ns:Key>
				<!--Optional:-->
				<ns:Value>?</ns:Value>
			</ns:KeyValues>
		</ns:OtherSegmentCodes>
		<!--Optional:-->
		<ns:EmployeeTypeCode>basic</ns:EmployeeTypeCode>
		<!--Optional:-->
		<ns:PayPlanCode>Equal Monthly</ns:PayPlanCode>
		<!--Optional:-->
		<ns:WageType>S</ns:WageType>
		<ns:Salary>108000</ns:Salary>
		<ns:FromDate>2018-01-01</ns:FromDate>
		<!--Optional:-->
		<ns:reviewType>Single</ns:reviewType>
		<!--Optional:-->
		<ns:notes>?</ns:notes>
	</ns:EmployeePosition>
	<ns:EmployeePosition>
	<!--Optional:-->
		<ns:EmployeeInfo>
		<!--Optional:-->
			<ns:ScenarioCode>EUB_Budget2018</ns:ScenarioCode>
			<!--Optional:-->
			<ns:HomeBudgetEntityCode>leaf</ns:HomeBudgetEntityCode>
			<!--Optional:-->
			<ns:Number>HA3000</ns:Number>
			<!--Optional:-->
			<ns:Name>HA3000</ns:Name>
			<ns:HireDate>2017-12-12</ns:HireDate>
		</ns:EmployeeInfo>
		<!--Optional:-->
		<ns:PositionName>HA11</ns:PositionName>
		<!--Optional:-->
		<ns:PositionEntityCode>leaf</ns:PositionEntityCode>
		<!--Optional:-->
		<ns:OtherSegmentCodes>
		<!--Zero or more repetitions:-->
		<ns:KeyValues>
			<!--Optional:-->
			<ns:Key>?</ns:Key>
			<!--Optional:-->
		<ns:Value>?</ns:Value>
		</ns:KeyValues>
		</ns:OtherSegmentCodes>
		<!--Optional:-->
		<ns:EmployeeTypeCode>basic</ns:EmployeeTypeCode>
		<!--Optional:-->
		<ns:PayPlanCode>Equal Monthly</ns:PayPlanCode>
		<!--Optional:-->
		<ns:WageType>S</ns:WageType>
		<ns:Salary>108000</ns:Salary>
		<ns:FromDate>2018-01-01</ns:FromDate>
		<!--Optional:-->
		<ns:reviewType>Single</ns:reviewType>
		<!--Optional:-->
		<ns:notes></ns:notes>
	</ns:EmployeePosition>
	</ns:employees1>
	<ns:payRollUploadDate>2018-10-10</ns:payRollUploadDate>
	<ns:AutoProcess>yes</ns:AutoProcess>
	</ns:LoadEmployees>
</soapenv:Body>
</soapenv:Envelope>

Success Response

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/ [schemas.xmlsoap.org]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance [w3.org]" xmlns:xsd="http://www.w3.org/2001/XMLSchema [w3.org]">
<soap:Body>
	<LoadEmployeesResponse xmlns="http://www.Planful.com/API/SOAP/StateFree/Common/2009/03/19">
	<LoadEmployeesResult>
	<EmployeeStatuses>
	<EmployeeStatus>
		<EmployeeInfo>
			<ScenarioCode>EUB_Budget2018</ScenarioCode>
			<HomeBudgetEntityCode>45</HomeBudgetEntityCode>
			<Number>Planful2000</Number>
			<Name>HA2000</Name>
			<HireDate>2017-12-12T00:00:00</HireDate>
		</EmployeeInfo>
		<Status>true</Status>
		<ErrorMessage>Employee added successfully.</ErrorMessage>
		<PositionName>HA2000</PositionName>
	</EmployeeStatus>
	<EmployeeStatus>
		<EmployeeInfo>
			<ScenarioCode>EUB_Budget2018</ScenarioCode>
			<HomeBudgetEntityCode>leaf</HomeBudgetEntityCode>
			<Number>HA3000</Number>
			<Name>HA3000</Name>
			<HireDate>2017-12-12T00:00:00</HireDate>
		</EmployeeInfo>
		<Status>true</Status>
		<ErrorMessage>Employee added successfully.</ErrorMessage>
		<PositionName>HA11</PositionName>
	</EmployeeStatus>
	</EmployeeStatuses>
		<TotalEmployeesLoaded>2</TotalEmployeesLoaded>
		<EmployeeLoadSuccessCount>2</EmployeeLoadSuccessCount>
		<EmployeeLoadFailureCount>0</EmployeeLoadFailureCount>
		<ProcessStatusMessage>Employee process triggered successfully</ProcessStatusMessage>
	</LoadEmployeesResult>
	</LoadEmployeesResponse>
</soap:Body>
</soap:Envelope>

Was this article helpful?

What's Next

GetEmployeeAllocationsData