Sort Members

Sorts the dimension members of a business process. You can sort Entity, Account, Scenario, Version, and user-defined custom dimension members. You cannot sort Period, Years, or Currency dimension members. This feature is only supported for the Planning and Free Form business processes.

After sorting members, administrators must perform a cube refresh.

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request specific to this job. For parameters that are generic to all jobs, see Execute a Job.

Table 5-28 Parameters

Name Description Required Default
jobType Sort Members Yes None
jobName The job name to be used for this job execution. Example: SortEntity No Sort Members
member Parent member whose children or descendants are being sorted. Yes None
order Order of sorting.

Possible values are:

  • ascending
  • descending
No ascending
type Sort children or descendants.

Possible values are:

  • children - sorting by children affects only members in the level immediately below the specified member
  • descendants - sorting by descendants affects all descendants of the specified member.
No children

Sample Payload

Example 1: Sorts the child members of the Account dimension in ascending order.

{
	"jobType":   "Sort Members",
	"jobName":  "SortAccount",
	"parameters":
	{
	"member":"Account"
	}
}

Example 2: Sorts the child members of the Account dimension in descending order.

{
	"jobType":   "Sort Members",
	"jobName":  "SortAccountDesc",
	"parameters":
	{
	"member":"Account", "order":"descending"
	}
}

Example 3: Sorts the descendants of member account200 in descending order.

{
	"jobType":   "Sort Members",
	"jobName":  "SortAccount200Desc",
	"parameters":
	{
	"member":"account200", "order":"descending", "type":"descendants"
	}
}