UpdateDepartmentDimensionSetup - accountsIQ/API-Wiki GitHub Wiki
The UpdateDepartmentDimensionSetup modifies the analysis setup of the BI Code/Department. This set of codes is used to perform reporting by analysis groups and links transaction values to multiple lines of reporting. There can be up to 6 analysis groups setup in the system and each group can have many elements under it. This method changes which elements are assigned to the transactions values linked to this BI Code / Department.
WARNING: this method updates all history and previous years reporting groups will be modified. Do not use this without having a full understanding of this and make sure that your client is aware and understands the implications.
public WSResultStatus UpdateDepartmentDimensionSetup(String token, String departmentID, String a1, String a2, String a3, String a4, String a5, String a6)| Parameter | Type | Description |
|---|---|---|
| token | String | The session token retrieved during authentication. |
| departmentID | String | The unique and immutable code for this BI Code / Department. This must already exist in the system. |
| a1 | String | Links the BI Code to an analysis group element of the first analysis group. This can ben null, but cannot be an element from a different group. The analysis code must already exist in the system. |
| a2 | String | Links the BI Code to an analysis group element of the second analysis group. This can ben null, but cannot be an element from a different group. The analysis code must already exist in the system. |
| a3 | String | Links the BI Code to an analysis group element of the third analysis group. This can ben null, but cannot be an element from a different group. The analysis code must already exist in the system. |
| a4 | String | Links the BI Code to an analysis group element of the fourth analysis group. This can ben null, but cannot be an element from a different group. The analysis code must already exist in the system. |
| a5 | String | Links the BI Code to an analysis group element of the fifth analysis group. This can ben null, but cannot be an element from a different group. The analysis code must already exist in the system. |
| a6 | String | Links the BI Code to an analysis group element of the sixth analysis group. This can ben null, but cannot be an element from a different group. The analysis code must already exist in the system. |
The following example considers an existing BI Code / Department called SALES-SOUTH. There are 3 analysis groups set up in this company, each with elements:
| Director | Region | Product Line |
|---|---|---|
| Kern | South | After Sales Services |
| O'Connor | North | Fault Analysis |
| Mart | West | Sales |
| East | Design | |
| Central |
SALES-SOUTH is currently linked to the director Kern, the region South and the product line After Sales Services. The director Kern is leaving and this now coming to be assigned to O'Connor. The following example realises the move:
Integration ws = new Integration();
String auth = ws.Login(entityID, partnerKey, userKey);
if( auth != null )
{
var result = ws.UpdateDepartmentDimensionSetup(auth, "SALES-SOUTH", "O'Connor", "South", "After Sales Services", null, null, null);
if(!result.Result) throw new Exception("Could not update the department");
}