Add Approval Role

Syntax

PlanfulAPIStateFreeClient.localplanful.OperationResult AddApprovalRoleForBudgetEntity(string userLogin, string entityCode, string roleName, string loginName, string password, string tenantCode)

Usage

This API automates approval role setup for budget users eliminating the need to select approval role options on an individual budget user basis.

Approval Role identifies user authorizations to perform template actions such as; approval actions related to budget templates, sales templates and initiative templates. Approval roles also provide users with access to sales information.

Setup functionality allows you to define varying levels of user responsibility for budget entities. For example, when a user has access to two entities (A and B), but has HR responsibility for entity B only, the user can be restricted to only view specific data based on HR access for the approval role assigned for the entity.

Assigning different approval roles for different entities provides a user with different levels of privileges. For example, an Admin role might provide ‘Workforce’ template access, but an ‘Admin with no HR’ role, might not have ‘HR’ (Workforce Planning) template access.

The following fields are required.

• User ID – typically the users name

• Segment - A segment is the Planful term for a dimension. Dimensions may be referred to as segments throughout the application.

• Code – represents the complete path to a budget entity. For example, Bob Smith is a Budget Manager and one of the segment codes he has access to is 2000-Americas|2100-US|2110-US North East|All.

Duplicate codes are supported, but the entire segment code path must be provided so that the API can properly identify it in regards to approval role access. For example, in the budget hierarchy below, the complete segment code path is provided. The paths are duplicates with the exception of the 100-100 entity.

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:AddApprovalRoleForBudgetEntity>
		<ns:userLogin>benparker@planful.com</ns:userLogin>
		<ns:entityCode>Entity</ns:entityCode>
		<ns:roleName>Budget Approver</ns:roleName>
		<ns:loginName>benparker@planful.com</ns:loginName>
		<ns:password>password</ns:password>
		<ns:tenantCode>TESTCPMTENANTBASEQA</ns:tenantCode>
	</ns:AddApprovalRoleForBudgetEntity>
	</soapenv:Body>
</soapenv:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<soap:Body>
	<AddApprovalRoleForBudgetEntityResponse xmlns="http://www.Planful.com/API/SOAP/StateFree/Common/2009/03/19">
		<AddApprovalRoleForBudgetEntityResult>
			<Success>true</Success>
			<message>Approval Role has been configured successfully</message>
		</AddApprovalRoleForBudgetEntityResult>
	</AddApprovalRoleForBudgetEntityResponse>
	</soap:Body>
</soap:Envelope>