WIP
RAFT Service
Include Page | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
(!) WIP h2. RAFT Service {include:Interface Style} {table:id=serviceMetaTable} {tr} {th:class=h}Name {th} {td:id=serviceName|colspan=2}RAFT Service {td} {tr} {tr} {th:class=h}Version {th} {td:id=serviceVersion}Dev ([0.1|RAFT 0.1]) {td} {td:id=serviceVersionHistory}[Release Notes|Search Service Release Notes#current] {td} {tr} {table} | [#References] | [#Operations] | [#Capabilities] | h3. Description The RAFT Service is focused on providing a consistent interface for: * Searching for Cost Objects and Cost Object Collections * Viewing Budget, Actual, Commitments, and Forecast information for Cost Object Collections * Creating What If scenarios as collections of speculations * Viewing the projected impacts of those speculations * Generating and viewing reports on this information h4. Child Services {include:Service Include Table Style Page} |
Description
The RAFT Service is focused on providing a consistent interface for:
- Searching for Cost Objects and Cost Object Collections
- Viewing Budget, Actual, Commitments, and Forecast information for Cost Object Collections
- Creating What If scenarios as collections of speculations
- Viewing the projected impacts of those speculations
- Generating and viewing reports on this information
Child Services
Include Page | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
{table:id=serviceIncludeTable}
{tr}
{td:class=includeServiceName}SearchService{td}
{td:class=includeServiceLink}[Search Service]{td}
{tr}
{tr}
{td:class=includeServiceName}CommentService{td}
{td:class=includeServiceLink}[Comment Service]{td}
{tr}
{tr}
{td:class=includeServiceName}AuthorizationService{td}
{td:class=includeServiceLink}[Authorization Service]{td}
{tr}
{tr}
{td:class=includeServiceName}ReportService{td}
{td:class=includeServiceLink}[Report Service]{td}
{tr}
{tr}
{td:class=includeServiceName}COMetadataService{td}
{td:class=includeServiceLink}[CO Metadata Service]{td}
{tr}
{tr}
{td:class=includeServiceName}CubeService{td}
{td:class=includeServiceLink}[Cube Service]{td}
{tr}
{tr}
{td:class=includeServiceName}WorksetService{td}
{td:class=includeServiceLink}[Workset Service]{td}
{tr}
{tr}
{td:class=includeServiceName}Scenario+Service{td}
{td:class=includeServiceLink}[Scenario Service]{td}
{tr}
{table}
h3. References
see RAFT Requirements Documentation |
References
see RAFT Requirements Documentation (RAFT-*)
Operations
Include Page | ||||
---|---|---|---|---|
|
Panel | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Domain Operations |
Panel | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
h3. Operations
{include:Method Table Style Page}
{panel:title=Setup|borderStyle=solid|borderColor=#cccccc|bgColor=#ffffff|titleBGColor=#eeeeee}
*Domain Operations*
[#getModelTypes]
{panel}
{panel:title=Search|borderStyle=solid|borderColor=#cccccc|bgColor=#ffffff|titleBGColor=#eeeeee}
searchbyParm(&parm)
Listinfo about user sets
|
Panel | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
addComment addWorksetAuthorizations List info about cost objects
withchildren)
listReport
Summary
Query
workset Management
scenario Management
recalcApptDetail
updateUserPrefGL
checkSystemStatus
checkProjectedBalance
addProjectTerm
showGlsInCategory
showVarianceonScenario |
Search
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
showlineItemsonGL {panel} h4. {color:#000066}{_}Search{_}{color} {anchor:searchByParm} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}searchByParm {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Searches the cost collector set and returns matches based on the passed in parameters {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}Array {td} {td:class=methodParamName}Parm {td} {td:class=methodParamDesc}An associative array of key value pairs for search parameters {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[coResultType|coResultTypeInfo Structure] {td} {td:class=methodReturnDesc}Returns cost object details for all of the matching cost objects. {td} {tr} {tr} {th:class=h|rowspan=2}Errors {th} {td:class=methodErrorType|colspan=2}NO_MATCH {td} {td:class=methodErrorDesc}No cost objects found {td} {tr} {tr} {td:class=methodErrorType|colspan=2}MAX_COUNT {td} {td:class=methodErrorDesc}Number of objects returned >250 {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} See RAFT-Search {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:searchCollectionbyParm} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}searchCollectionByParm {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Performs a collection search based off the identified parameters. Collection searches cannot be used to define sets {td} {tr} {tr} {th:class=h|rowspan=2}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}Collection {td} {td:class=methodParamDesc}Which collection will be searched, one of supervisor, sponsor, fund_center, profit_center, workset {td} {tr} {tr} {td:class=methodParamType}Array {td} {td:class=methodParamName}Parm {td} {td:class=methodParamDesc}An associative array of key value pairs for search parameters {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[collectionResultType|collectionResultTypeInfo Structure] {td} {td:class=methodReturnDesc}Returns cost object details for all of the matching cost objects wrapped in a metadata header for the collection. {td} {tr} {tr} {th:class=h|rowspan=2}Errors {th} {td:class=methodErrorType|colspan=2}NO_MATCH {td} {td:class=methodErrorDesc}No cost objects found {td} {tr} {tr} {td:class=methodErrorType|colspan=2}MAX_COUNT {td} {td:class=methodErrorDesc}Count of returned objects (including the collection header) exceeds 250 and cannot be displayed. {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:getSearchLists} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}getSearchLists {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Returns the default collection of selection items for each of the search lists. {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}Array {td} {td:class=methodParamName}Parm {td} {td:class=methodParamDesc}An associative array of key value pairs for search parameters {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[listSetResultType|listSetResultTypeInfo Structure] {td} {td:class=methodReturnDesc}Master structure for list data that includes supervisor, addressee, sponsor, prime_sponsor, workset. The set always returns a max of 150 entries. To extend beyond that requires the user to use the autocomplete methods. {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2} {td} {td:class=methodErrorDesc} {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:listSupervisor} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}listSupervisor {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Returns the list of supervisors accessible by the requesting user. {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}Integer {td} {td:class=methodParamName}Count {td} {td:class=methodParamDesc}The number of entries to return. {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[listResultType|listResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Array list of key, value pairs {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2} {td} {td:class=methodErrorDesc} {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:listAddressee} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}listAddressee {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Returns the list of adressees accessible by the requesting user. {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}Integer {td} {td:class=methodParamName}Count {td} {td:class=methodParamDesc}The number of entries to return. {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[listResultType|listResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Array list of key, value pairs {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2} {td} {td:class=methodErrorDesc} {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:listSponsor} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}listSponsor {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Returns the list of sponsors accessible by the requesting user. {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}Integer {td} {td:class=methodParamName}Count {td} {td:class=methodParamDesc}The number of entries to return. {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[listResultType|listResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Array list of key, value pairs {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2} {td} {td:class=methodErrorDesc} {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:listPrimeSponsor} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}listPrimeSponsor {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Returns the list of prime sponsors accessible by the requesting user. {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}Integer {td} {td:class=methodParamName}Count {td} {td:class=methodParamDesc}The number of entries to return. {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[listResultType|listResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Array list of key, value pairs {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2} {td} {td:class=methodErrorDesc} {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:listWorkset} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}listWorkset {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Returns the list of worksets accessible by the requesting user. {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}Integer {td} {td:class=methodParamName}Count {td} {td:class=methodParamDesc}The number of entries to return. {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[listResultType|listResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Array list of key, value pairs {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2} {td} {td:class=methodErrorDesc} {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:listId} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}listId {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Returns the list of cost object ids and titles accessible by the requesting user. {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}Integer {td} {td:class=methodParamName}Count {td} {td:class=methodParamDesc}The number of entries to return. {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[listResultType|listResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Array list of key, value pairs {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2} {td} {td:class=methodErrorDesc} {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:listFlaggedCostObjects} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}listFlaggedCostObjects {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Returns the list of flagged cost objects flagged by the requesting user. {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}Integer {td} {td:class=methodParamName}Count {td} {td:class=methodParamDesc}The number of entries to return. {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[coResultType|coResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Returns cost object details for all of the matching cost objects {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2} {td} {td:class=methodErrorDesc} {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Comment
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations]
h4. {color:#000066}{_}Comment{_}{color}
{anchor:addComment}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}addComment
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Adds a comment to the identified object
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Parameters
{th}
{td:class=methodParamType}Comment_Type
{td}
{td:class=methodParamName}Comment_Type
{td}
{td:class=methodParamDesc}Denotes whether a particular comment is public or private.
{td}
{tr}
{tr}
{td:class=methodParamType}Ref_Type
{td}
{td:class=methodParamName}Ref_Type
{td}
{td:class=methodParamDesc}Identifies what sort of speculation the reference is on (EXPENSE_RULE, APPT_RULE, APPT, CO, SCENARIO, WORKSET)
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}REF_ID
{td}
{td:class=methodParamDesc}The object id for the associated item (cost_collector_key, etc.)
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}Returns status information and object id for the action (in this case, the comment)
{td}
{tr}
{tr}
{th:class=h|rowspan=4}Errors
{th}
{td:class=methodErrorType|colspan=2}EXISTS
{td}
{td:class=methodErrorDesc}Object already exists
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Object identified by REF_ID does not exist
{td}
{tr}
{td:class=methodErrorType|colspan=2}EMPTY
{td}
{td:class=methodErrorDesc}Comment body is empty
{td}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User does not have comment authorizations here.
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table} |
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
[Back to Operations|#Operations] {anchor:deleteComment} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}deleteComment {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Sets the status for the identified comment to 'D', effectively removing the comment from display. {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}Array {td} {td:class=methodParamName}Parm {td} {td:class=methodParamDesc}An associative array of key value pairs for search parameters {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure] {td} {td:class=methodReturnDesc}Returns the result status and objectId for the action. {td} {tr} {tr} {th:class=h|rowspan=2}Errors {th} {td:class=methodErrorType|colspan=2}NO_MATCH {td} {td:class=methodErrorDesc}No comment match found {td} {tr} {tr} {td:class=methodErrorType|colspan=2}NO_AUTH {td} {td:class=methodErrorDesc}User cannot delete this authorization. {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:getComment} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}getComment {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Requests the Comment from the system. {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}Comment_Id {td} {td:class=methodParamDesc}The specific comment to retreive {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[commentResultType|commentResultTypeInfo Structure] {td} {td:class=methodReturnDesc}Object containing the associated comments {td} {tr} {tr} {th:class=h|rowspan=2}Errors {th} {td:class=methodErrorType|colspan=2}NO_MATCH {td} {td:class=methodErrorDesc}No comment found {td} {tr} {tr} {td:class=methodErrorType|colspan=2}NO_AUTH {td} {td:class=methodErrorDesc}User does not have access to this comment {td} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:getCommentsforObject} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}getCommentsforObject {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Returns all comments associated with the identified object {td} {tr} {tr} {th:class=h|rowspan=2}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}REF_TYPE {td} {td:class=methodParamDesc}The type of object to look up comments for {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}REF_ID {td} {td:class=methodParamDesc}The Id for the object to look up comments for (cost_collector_key, personell_key, etc.) {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[commentResultType|commentResultTypeInfo Structure] {td} {td:class=methodReturnDesc}Object containing the associated comments. If there is no match than an empty structure is returned. {td} {tr} {tr} {th:class=h|rowspan=2}Errors {th} {td:class=methodErrorType|colspan=2}NO_MATCH {td} {td:class=methodErrorDesc}No object found {td} {tr} {tr} {td:class=methodErrorType|colspan=2}NO_AUTH {td} {td:class=methodErrorDesc}User does not have access to look at comments on this object. {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
RAFT Authorizations
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] h4. {color:#000066}{_}RAFT Authorizations{_}{color} {anchor:addWorksetAuthorization} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}addWorksetAuthorization {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=4}Adds a particular authorization for a Workset to the system {td} {tr} {tr} {th:class=h|rowspan=4}Parameters {th} {td:class=methodParamType}REF_TYPE {td} {td:class=methodParamName}Object_Type {td} {td:class=methodParamDesc}The type of object to be authorized (currently always WORKSET). The Object's Qualifier_Type {td} {tr} {tr} {td:class=methodParamType}REF_KEY {td} {td:class=methodParamName}Object_ID {td} {td:class=methodParamDesc}The id of the object to be authorized. The Object Qualifier. {td} {tr} {tr} {td:class=methodParamType}AUTH_TYPE {td} {td:class=methodParamName}Authorization {td} {td:class=methodParamDesc}What type of authorization to set {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}User {td} {td:class=methodParamDesc}The kerb_name for the associated user {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure] {td} {td:class=methodReturnDesc}Returns status information and object id for the action (in this case, the comment) {td} {tr} {tr} {th:class=h|rowspan=3}Errors {th} {td:class=methodErrorType|colspan=2}EXISTS {td} {td:class=methodErrorDesc}Authorization already exists {td} {tr} {tr} {td:class=methodErrorType|colspan=2}NO_MATCH {td} {td:class=methodErrorDesc}Object identified by REF_KEY does not exist {td} {tr} {tr} {td:class=methodErrorType|colspan=2}NO_AUTH {td} {td:class=methodErrorDesc}User does not have authorizations to peform this action here. {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:dropWorksetAuthorization} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=4}dropWorksetAuthorization {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=4}Removes a particular authorization for a Workset from the system {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}Auth_Key {td} {td:class=methodParamDesc}The authorization key to be removed {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure] {td} {td:class=methodReturnDesc}Returns status information and object id for the action {td} {tr} {tr} {th:class=h|rowspan=3}Errors {th} {td:class=methodErrorType|colspan=2}NO_MATCH {td} {td:class=methodErrorDesc}Authorization identified by AUTH_Key does not exist {td} {tr} {tr} {td:class=methodErrorType|colspan=2}EMPTY {td} {td:class=methodErrorDesc}Comment body is empty {td} {tr} {tr} {td:class=methodErrorType|colspan=2}NO_AUTH {td} {td:class=methodErrorDesc}User does not have authorizations to perform this action. {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:viewAuthorizationsforUser} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}viewAuthorizationsforUser {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}View the authorizations for this user {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}User {td} {td:class=methodParamDesc}The user to view the authorizations for. The kerb_name. {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[authResultType|authResultTypeInfo Structure] {td} {td:class=methodReturnDesc}Returns all the authorizations for the user {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2}NO_MATCH {td} {td:class=methodErrorDesc}No user found {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:viewAuthorizationsforObject} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}viewAuthorizationsforObject {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Provide a breakdown of all of the authorizations for a particular object {td} {tr} {tr} {th:class=h|rowspan=2}Parameters {th} {td:class=methodParamType}Ref_Type {td} {td:class=methodParamName}Ref_Type {td} {td:class=methodParamDesc}The type of object. The qualifier_type {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}REF_KEY {td} {td:class=methodParamDesc}The unique identifier for the object (cost_collector_key, personnel_key, etc.) {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[authResultType|authResultTypeInfo Structure] {td} {td:class=methodReturnDesc}Returns all authorizations for the associated object. {td} {tr} {tr} {th:class=h|rowspan=2}Errors {th} {td:class=methodErrorType|colspan=2}NO_MATCH {td} {td:class=methodErrorDesc}No cost objects found {td} {tr} {tr} {td:class=methodErrorType|colspan=2}NO_AUTH {td} {td:class=methodErrorDesc}User cannot view the associated authorizations {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:isAuthorized} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}isAuthorized {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=4}Can the given user perform the specified function {td} {tr} {tr} {th:class=h|rowspan=4}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}User {td} {td:class=methodParamDesc}An associative array of key value pairs for search parameters {td} {tr} {tr} {td:class=methodParamType}REF_Type {td} {td:class=methodParamName}REF_TYPE {td} {td:class=methodParamDesc}The type of object to perform the action on. The Qualifier_Type {td} {tr} {tr} {td:class=methodParamType}REF_Key {td} {td:class=methodParamName}User {td} {td:class=methodParamDesc}The key of the associated object (Cost_Collector_key, Personell_Key, etc.) {td} {tr} {tr} {td:class=methodParamType}AUTH_TYPE {td} {td:class=methodParamName}Action {td} {td:class=methodParamDesc}The function the user is attempting to perform. {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[boolean|booleanResultTypeInfo Structure] {td} {td:class=methodReturnDesc}Can the user perform the action identified by 'AUTH_TYPE' for the specified REF_TYPE/IDi (Y/N) {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2}NO_MATCH {td} {td:class=methodErrorDesc}Cannot find the object to be accessed. {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
CO Metadata
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] h4. {color:#000066}{_}CO Metadata{_}{color} {anchor:listBudgets} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}listBudgets {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Returns the list of budgets available for the specified Cost Object. {td} {tr} {tr} {th:class=h|rowspan=2}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}Cost_Collector_key {td} {td:class=methodParamDesc}The cost object to look up {td} {tr} {tr} {td:class=methodParamType}Boolean {td} {td:class=methodParamName}with_children {td} {td:class=methodParamDesc}Include children accounts. {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[listResultType|listResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Array list of key, value pairs. In this case, key = budget version code, value = Description {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2} {td} {td:class=methodErrorDesc} {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:listWorksetScenarios} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}listWorksetScenarios {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Returns the list of Scenarios associated with this workset. This list is implicitly restricted to the scenarios that the accessing user has access to. {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}Workset_Key {td} {td:class=methodParamDesc}The id for this workset {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[listResultType|listResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Array list of key, value pairs. In this case, key = scenario ID, value = scenario name {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2} {td} {td:class=methodErrorDesc} {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:listProjectPeriods} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}listProjectPeriods {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Returns the list of Project Periods for this cost object {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}Cost_collector_key {td} {td:class=methodParamDesc}The identifier for this cost object {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[projectYearResultType|projectYearResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Returns the project year date ranges associated with this cost object {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2} {td} {td:class=methodErrorDesc} {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:updateProjectPeriod} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}updateProjectPeriod {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=4}For the given project period, alter the start and end date. {td} {tr} {tr} {th:class=h|rowspan=4}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}Cost_collector_key {td} {td:class=methodParamDesc}The identifier for this cost object {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}Project_Period_Key {td} {td:class=methodParamDesc}The identifier for this project period {td} {tr} {tr} {td:class=methodParamType}Date {td} {td:class=methodParamName}Start_Date {td} {td:class=methodParamDesc}The start date for this project period {td} {tr} {tr} {td:class=methodParamType}Date {td} {td:class=methodParamName}End_Date {td} {td:class=methodParamDesc}The end date for this project period {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Returns the confirmation status along with the object reference. {td} {tr} {tr} {th:class=h|rowspan=3}Errors {th} {td:class=methodErrorType|colspan=2}NO_MATCH {td} {td:class=methodErrorDesc} No match for this project period/cost object {td} {tr} {tr} {td:class=methodErrorType|colspan=2}OVERLAP {td} {td:class=methodErrorDesc}Warning: Project period now overlaps another project period defined for this cost object {td} {tr} {tr} {td:class=methodErrorType|colspan=2}INVALID {td} {td:class=methodErrorDesc}Project period defined outside of start/final expiration date range for this cost object {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:addProjectPeriod} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}addProjectPeriod {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=4}Add project year to cost object {td} {tr} {tr} {th:class=h|rowspan=4}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}Cost_collector_key {td} {td:class=methodParamDesc}The identifier for this cost object {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}Project_Period_Key {td} {td:class=methodParamDesc}The identifier for this project period {td} {tr} {tr} {td:class=methodParamType}Date {td} {td:class=methodParamName}Start_Date {td} {td:class=methodParamDesc}The start date for this project period {td} {tr} {tr} {td:class=methodParamType}Date {td} {td:class=methodParamName}End_Date {td} {td:class=methodParamDesc}The end date for this project period {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Returns the confirmation status along with the object reference. {td} {tr} {tr} {th:class=h|rowspan=3}Errors {th} {td:class=methodErrorType|colspan=2}NO_MATCH {td} {td:class=methodErrorDesc} No match for this cost object {td} {tr} {tr} {td:class=methodErrorType|colspan=2}OVERLAP {td} {td:class=methodErrorDesc}Warning: Project period now overlaps another project period defined for this cost object {td} {tr} {tr} {td:class=methodErrorType|colspan=2}INVALID {td} {td:class=methodErrorDesc}Project period defined outside of start/final expiration date range for this cost object {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:dropProjectPeriod} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}dropProjectPeriod {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=4}Delete project year from cost object {td} {tr} {tr} {th:class=h|rowspan=2}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}Cost_collector_key {td} {td:class=methodParamDesc}The identifier for this cost object {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}Project_Period_Key {td} {td:class=methodParamDesc}The identifier for this project period {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Returns the confirmation status along with the object reference. {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2}NO_MATCH {td} {td:class=methodErrorDesc} No match for this cost object {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:validateProjectPeriods} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}validateProjectPeriods {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=4}Validate that the project periods are contiguous and non overlapping, and that they begin at the start of the project and end at the end of the final expiration date {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}Cost_collector_key {td} {td:class=methodParamDesc}The identifier for this cost object {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[validateResultType|validateResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Returns the validity status of the project periods on the cost object and identifies exceptions {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2}NO_MATCH {td} {td:class=methodErrorDesc} No match for this cost object {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:normalizeProjectPeriods} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}normalizeProjectPeriods {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=4}Starting from the first period, push out the start date of the subsequent project periods so that the full set of project periods are contiguous and non-overlapping {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}Cost_collector_key {td} {td:class=methodParamDesc}The identifier for this cost object {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[validateResultType|validateResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Returns the validity status of the project periods on the cost object and identifies exceptions {td} {tr} {tr} {th:class=h|rowspan=2}Errors {th} {td:class=methodErrorType|colspan=2}NO_MATCH {td} {td:class=methodErrorDesc} No match for this cost object {td} {tr} {tr} {td:class=methodErrorType|colspan=2}INCOMPLETE {td} {td:class=methodErrorDesc} Warning: Project Period schedule does not cover the full date range for this CO (from effective through final expiration date) {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [Back to Operations|#Operations] h4. {color:#000066}{_}Reports{_}{color} h4. {color:{td} {tr} {table} |
Reports
Reports
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
#000066}{_}Reports{_}{color} {anchor:listReports} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}listReports {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}For a given context, list the available reports in that context {td} {tr} {tr} {th:class=h|rowspan=2}Parameters {th} {td:class=methodParamType}REF_TYPE {td} {td:class=methodParamName}REF_TYPE {td} {td:class=methodParamDesc}The context. Workset, Scenario, Person, Cost Object, Allocation {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}REF_KEY {td} {td:class=methodParamDesc}(optional) A unique identifier for a particular object. For object specific reports {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[reportListResultType|reportListResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Array list of reports. Returns the ID, Title, and Description for the report {td} {tr} {tr} {th:class=h|rowspan=2}Errors {th} {td:class=methodErrorType|colspan=2}NO_MATCH {td} {td:class=methodErrorDesc} Warning: No reports for specific ref_key found. Returning report list for the general context. {td} {tr} {tr} {td:class=methodErrorType|colspan=2}INVALID {td} {td:class=methodErrorDesc} Invalid REF_TYPE identified {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:executeReport} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}executeReport {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Returns the result document for the report request {td} {tr} {tr} {th:class=h|rowspan=3}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}Report_ID {td} {td:class=methodParamDesc}The id for this report {td} {tr} {tr} {td:class=methodParamType}FORMAT_TYPE {td} {td:class=methodParamName}FORMAT_TYPE {td} {td:class=methodParamDesc}The format type, one of: XLS,CSV,PDF,HTML,(addional options depend on the backend) {td} {tr} {tr} {td:class=methodParamType}@PARM {td} {td:class=methodParamName}PARM {td} {td:class=methodParamDesc}Associative array of parameters {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[reportResultType|reportResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Returns the resulting report object {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2}ERROR {td} {td:class=methodErrorDesc}Report processing error (Error passed in body) {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Summary
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] h4. {color:#000066}{_}Summary{_}{color} {anchor:BvAQueryDay} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}BvAQueryDay {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Summary by GL hierarchy of the budgets, actuals, and commitment information for an account. Expenses only. {td} {tr} {tr} {th:class=h|rowspan=9}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}GL_Hierarchy {td} {td:class=methodParamDesc}The Hierarchy of GL categories and accounts to use. {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}Budget_version {td} {td:class=methodParamDesc}Which budget to use {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}Scenario_version {td} {td:class=methodParamDesc}Which scenario to use {td} {tr} {tr} {td:class=methodParamType}Cost_collector_key {td} {td:class=methodParamName}Cost_collector_key {td} {td:class=methodParamDesc}The identifier for the cost object {td} {tr} {tr} {td:class=methodParamType}Date {td} {td:class=methodParamName}Start_Date {td} {td:class=methodParamDesc}The start date for the query window {td} {tr} {tr} {td:class=methodParamType}Date {td} {td:class=methodParamName}End_Date {td} {td:class=methodParamDesc}The end_date for the query window {td} {tr} {tr} {td:class=methodParamType}Boolean {td} {td:class=methodParamName}with_children {td} {td:class=methodParamDesc}Consolidate the results to include all associated children with the parent {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}Collection_type {td} {td:class=methodParamDesc}When including children, use the following collection for the aggregation {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}Collection_key {td} {td:class=methodParamDesc}When including children, use this particular collection key as the root of the consolidation tree {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[coSummaryResultType|coSummaryResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Flattened cube of summary financial information {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2}NO_MATCH {td} {td:class=methodErrorDesc}Either the Cost object or collection key does not exist in the system {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:RvEQueryDay} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}RvEQueryDay {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Summary by GL hierarchy of the budgets, actuals, and commitment information for an account. Revenue & Expenses. {td} {tr} {tr} {th:class=h|rowspan=9}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}GL_Hierarchy {td} {td:class=methodParamDesc}The Hierarchy of GL categories and accounts to use. {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}Budget_version {td} {td:class=methodParamDesc}Which budget to use {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}Scenario_version {td} {td:class=methodParamDesc}Which scenario to use {td} {tr} {tr} {td:class=methodParamType}Cost_collector_key {td} {td:class=methodParamName}Cost_collector_key {td} {td:class=methodParamDesc}The identifier for the cost object {td} {tr} {tr} {td:class=methodParamType}Date {td} {td:class=methodParamName}Start_Date {td} {td:class=methodParamDesc}The start date for the query window {td} {tr} {tr} {td:class=methodParamType}Date {td} {td:class=methodParamName}End_Date {td} {td:class=methodParamDesc}The end_date for the query window {td} {tr} {tr} {td:class=methodParamType}Boolean {td} {td:class=methodParamName}with_children {td} {td:class=methodParamDesc}Consolidate the results to include all associated children with the parent {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}Collection_type {td} {td:class=methodParamDesc}When including children, use the following collection for the aggregation {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}Collection_key {td} {td:class=methodParamDesc}When including children, use this particular collection key as the root of the consolidation tree {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[coSummaryResultType|coSummaryResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Flattened cube of summary financial information {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2}NO_MATCH {td} {td:class=methodErrorDesc}Either the Cost object or collection key does not exist in the system {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:BvAQueryMonthly} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}BvAQueryMonthly {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Summary by GL hierarchy of the budgets, actuals, and commitment information for an account. Expenses only. Monthly view {td} {tr} {tr} {th:class=h|rowspan=9}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}GL_Hierarchy {td} {td:class=methodParamDesc}The Hierarchy of GL categories and accounts to use. {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}Budget_version {td} {td:class=methodParamDesc}Which budget to use {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}Scenario_version {td} {td:class=methodParamDesc}Which scenario to use {td} {tr} {tr} {td:class=methodParamType}Cost_collector_key {td} {td:class=methodParamName}Cost_collector_key {td} {td:class=methodParamDesc}The identifier for the cost object {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}Start_Period {td} {td:class=methodParamDesc}The start period for the query window - format = YYYYMM {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}End_Period {td} {td:class=methodParamDesc}The end_date for the query window - format = YYYYMM {td} {tr} {tr} {td:class=methodParamType}Boolean {td} {td:class=methodParamName}with_children {td} {td:class=methodParamDesc}Consolidate the results to include all associated children with the parent {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}Collection_type {td} {td:class=methodParamDesc}When including children, use the following collection for the aggregation {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}Collection_key {td} {td:class=methodParamDesc}When including children, use this particular collection key as the root of the consolidation tree {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[coSummaryResultType|coSummaryResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Flattened cube of summary financial information {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2}NO_MATCH {td} {td:class=methodErrorDesc}Either the Cost object or collection key does not exist in the system {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [Back to Operations|#Operations] {table} |
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
anchor:RvEQueryMonth} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}RvEQueryMonth {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Summary by GL hierarchy of the budgets, actuals, and commitment information for an account. Revenue & Expenses. Monthly view {td} {tr} {tr} {th:class=h|rowspan=9}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}GL_Hierarchy {td} {td:class=methodParamDesc}The Hierarchy of GL categories and accounts to use. {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}Budget_version {td} {td:class=methodParamDesc}Which budget to use {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}Scenario_version {td} {td:class=methodParamDesc}Which scenario to use {td} {tr} {tr} {td:class=methodParamType}Cost_collector_key {td} {td:class=methodParamName}Cost_collector_key {td} {td:class=methodParamDesc}The identifier for the cost object {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}Start_Period {td} {td:class=methodParamDesc}The start period for the query window - format = YYYYMM {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}End_Period {td} {td:class=methodParamDesc}The end period for the query window - format = YYYYMM {td} {tr} {tr} {td:class=methodParamType}Boolean {td} {td:class=methodParamName}with_children {td} {td:class=methodParamDesc}Consolidate the results to include all associated children with the parent {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}Collection_type {td} {td:class=methodParamDesc}When including children, use the following collection for the aggregation {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}Collection_key {td} {td:class=methodParamDesc}When including children, use this particular collection key as the root of the consolidation tree {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[coSummaryResultType|coSummaryResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Flattened cube of summary financial information {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2}NO_MATCH {td} {td:class=methodErrorDesc}Either the Cost object or collection key does not exist in the system {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
...
Drill-down
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
{_}{color} {anchor:queryActualsSumm} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}queryActualsSumm {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Returns a summary of the totals by GL/CO {td} {tr} {tr} {th:class=h|rowspan=10}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}GL_HIER {td} {td:class=methodParamDesc}The gl_hierarchy to use {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}GL_Level {td} {td:class=methodParamDesc}The GL Category or Account to show items from {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}CoArray {td} {td:class=methodParamDesc}The cost_collector_key {td} {tr} {tr} {td:class=methodParamType}Zend_Date {td} {td:class=methodParamName}Start_Date {td} {td:class=methodParamDesc}Start date for the query window {td} {tr} {tr} {td:class=methodParamType}Zend_Date {td} {td:class=methodParamName}End_Date {td} {td:class=methodParamDesc}End_Date for the query window {td} {tr} {tr} {td:class=methodParamType}Boolean {td} {td:class=methodParamName}with_children {td} {td:class=methodParamDesc}Include children? {td} {tr} {tr} {td:class=methodParamType}Integer {td} {td:class=methodParamName}Start {td} {td:class=methodParamDesc}Start at record # {td} {tr} {tr} {td:class=methodParamType}Integer {td} {td:class=methodParamName}End {td} {td:class=methodParamDesc}Return up to and including record # {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}filter {td} {td:class=methodParamDesc}Return records with string in the body {td} {tr} {tr} {td:class=methodParamType}Array {td} {td:class=methodParamName}ordercol {td} {td:class=methodParamDesc}The sorting for the structure {td} {tr} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[actSummResultType|actSummResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Returns the matching collection of actuals records {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2}NO_RECORDS {td} {td:class=methodErrorDesc}No records found {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:queryActualsPODetail} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}queryActualsPODetail {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Returns matching actuals expense Records (rename?) {td} {tr} {tr} {th:class=h|rowspan=10}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}GL_HIER {td} {td:class=methodParamDesc}The gl_hierarchy to use {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}GL_Level {td} {td:class=methodParamDesc}The GL Category or Account to show items from {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}CoArray {td} {td:class=methodParamDesc}The cost_collector_key {td} {tr} {tr} {td:class=methodParamType}Zend_Date {td} {td:class=methodParamName}Start_Date {td} {td:class=methodParamDesc}Start date for the query window {td} {tr} {tr} {td:class=methodParamType}Zend_Date {td} {td:class=methodParamName}End_Date {td} {td:class=methodParamDesc}End_Date for the query window {td} {tr} {tr} {td:class=methodParamType}Boolean {td} {td:class=methodParamName}with_children {td} {td:class=methodParamDesc}Include children? {td} {tr} {tr} {td:class=methodParamType}Integer {td} {td:class=methodParamName}Start {td} {td:class=methodParamDesc}Start at record # {td} {tr} {tr} {td:class=methodParamType}Integer {td} {td:class=methodParamName}End {td} {td:class=methodParamDesc}Return up to and including record # {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}filter {td} {td:class=methodParamDesc}Return records with string in the body {td} {tr} {tr} {td:class=methodParamType}Array {td} {td:class=methodParamName}ordercol {td} {td:class=methodParamDesc}The sorting for the structure {td} {tr} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[actPOResultType|actPOResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Returns the matching collection of actuals records {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2}NO_RECORDS {td} {td:class=methodErrorDesc}No records found {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:queryActualsPEDetail} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}queryActualsPEDetail {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Returns matching actuals personnel Records (rename?) {td} {tr} {tr} {th:class=h|rowspan=10}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}GL_HIER {td} {td:class=methodParamDesc}The gl_hierarchy to use {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}GL_Level {td} {td:class=methodParamDesc}The GL Category or Account to show items from {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}CoArray {td} {td:class=methodParamDesc}The cost_collector_key {td} {tr} {tr} {td:class=methodParamType}Zend_Date {td} {td:class=methodParamName}Start_Date {td} {td:class=methodParamDesc}Start date for the query window {td} {tr} {tr} {td:class=methodParamType}Zend_Date {td} {td:class=methodParamName}End_Date {td} {td:class=methodParamDesc}End_Date for the query window {td} {tr} {tr} {td:class=methodParamType}Boolean {td} {td:class=methodParamName}with_children {td} {td:class=methodParamDesc}Include children? {td} {tr} {tr} {td:class=methodParamType}Integer {td} {td:class=methodParamName}Start {td} {td:class=methodParamDesc}Start at record # {td} {tr} {tr} {td:class=methodParamType}Integer {td} {td:class=methodParamName}End {td} {td:class=methodParamDesc}Return up to and including record # {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}filter {td} {td:class=methodParamDesc}Return records with string in the body {td} {tr} {tr} {td:class=methodParamType}Array {td} {td:class=methodParamName}ordercol {td} {td:class=methodParamDesc}The sorting for the structure {td} {tr} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[actPEResultType|actPEResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Returns the matching collection of actuals records {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2}NO_RECORDS {td} {td:class=methodErrorDesc}No records found {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:queryBudgetDetail} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}queryBudgetDetail {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Returns matching budget records (SAP = GL Level, COEUS = line item level) {td} {tr} {tr} {th:class=h|rowspan=11}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}GL_HIER {td} {td:class=methodParamDesc}The gl_hierarchy to use {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}GL_Level {td} {td:class=methodParamDesc}The GL Category or Account to show items from {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}CoArray {td} {td:class=methodParamDesc}The cost_collector_key {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}Budget Version {td} {td:class=methodParamDesc}The plan version for the associated budget {td} {tr} {tr} {td:class=methodParamType}Zend_Date {td} {td:class=methodParamName}Start_Date {td} {td:class=methodParamDesc}Start date for the query window {td} {tr} {tr} {td:class=methodParamType}Zend_Date {td} {td:class=methodParamName}End_Date {td} {td:class=methodParamDesc}End_Date for the query window {td} {tr} {tr} {td:class=methodParamType}Boolean {td} {td:class=methodParamName}with_children {td} {td:class=methodParamDesc}Include children? {td} {tr} {tr} {td:class=methodParamType}Integer {td} {td:class=methodParamName}Start {td} {td:class=methodParamDesc}Start at record # {td} {tr} {tr} {td:class=methodParamType}Integer {td} {td:class=methodParamName}End {td} {td:class=methodParamDesc}Return up to and including record # {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}filter {td} {td:class=methodParamDesc}Return records with string in the body {td} {tr} {tr} {td:class=methodParamType}Array {td} {td:class=methodParamName}ordercol {td} {td:class=methodParamDesc}The sorting for the structure {td} {tr} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[budResultType|budPEResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Returns the matching collection of actuals records {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2}NO_RECORDS {td} {td:class=methodErrorDesc}No records found {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:queryCommitmentsSumm} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}queryCommitmentsSumm {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Returns a summary of the commitments information by gl {td} {tr} {tr} {th:class=h|rowspan=10}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}GL_HIER {td} {td:class=methodParamDesc}The gl_hierarchy to use {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}GL_Level {td} {td:class=methodParamDesc}The GL Category or Account to show items from {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}CoArray {td} {td:class=methodParamDesc}The cost_collector_key {td} {tr} {tr} {td:class=methodParamType}Zend_Date {td} {td:class=methodParamName}Start_Date {td} {td:class=methodParamDesc}Start date for the query window {td} {tr} {tr} {td:class=methodParamType}Zend_Date {td} {td:class=methodParamName}End_Date {td} {td:class=methodParamDesc}End_Date for the query window {td} {tr} {tr} {td:class=methodParamType}Boolean {td} {td:class=methodParamName}with_children {td} {td:class=methodParamDesc}Include children? {td} {tr} {tr} {td:class=methodParamType}Integer {td} {td:class=methodParamName}Start {td} {td:class=methodParamDesc}Start at record # {td} {tr} {tr} {td:class=methodParamType}Integer {td} {td:class=methodParamName}End {td} {td:class=methodParamDesc}Return up to and including record # {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}filter {td} {td:class=methodParamDesc}Return records with string in the body {td} {tr} {tr} {td:class=methodParamType}Array {td} {td:class=methodParamName}ordercol {td} {td:class=methodParamDesc}The sorting for the structure {td} {tr} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[commSummResultType|commSummResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Returns the matching collection of actuals records {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2}NO_RECORDS {td} {td:class=methodErrorDesc}No records found {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:queryCommitmentsPODetail} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}queryCommitmentsPODetail {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Returns matching commitments expense Records (rename?) {td} {tr} {tr} {th:class=h|rowspan=10}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}GL_HIER {td} {td:class=methodParamDesc}The gl_hierarchy to use {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}GL_Level {td} {td:class=methodParamDesc}The GL Category or Account to show items from {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}CoArray {td} {td:class=methodParamDesc}The cost_collector_key {td} {tr} {tr} {td:class=methodParamType}Zend_Date {td} {td:class=methodParamName}Start_Date {td} {td:class=methodParamDesc}Start date for the query window {td} {tr} {tr} {td:class=methodParamType}Zend_Date {td} {td:class=methodParamName}End_Date {td} {td:class=methodParamDesc}End_Date for the query window {td} {tr} {tr} {td:class=methodParamType}Boolean {td} {td:class=methodParamName}with_children {td} {td:class=methodParamDesc}Include children? {td} {tr} {tr} {td:class=methodParamType}Integer {td} {td:class=methodParamName}Start {td} {td:class=methodParamDesc}Start at record # {td} {tr} {tr} {td:class=methodParamType}Integer {td} {td:class=methodParamName}End {td} {td:class=methodParamDesc}Return up to and including record # {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}filter {td} {td:class=methodParamDesc}Return records with string in the body {td} {tr} {tr} {td:class=methodParamType}Array {td} {td:class=methodParamName}ordercol {td} {td:class=methodParamDesc}The sorting for the structure {td} {tr} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[commPOResultType|commPOResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Returns the matching collection of actuals records {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2}NO_RECORDS {td} {td:class=methodErrorDesc}No records found {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:queryCommitmentsPEDetail} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}queryCommitmentsPEDetail {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Returns matching commitments personnel Records (rename?) {td} {tr} {tr} {th:class=h|rowspan=10}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}GL_HIER {td} {td:class=methodParamDesc}The gl_hierarchy to use {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}GL_Level {td} {td:class=methodParamDesc}The GL Category or Account to show items from {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}CoArray {td} {td:class=methodParamDesc}The cost_collector_key {td} {tr} {tr} {td:class=methodParamType}Zend_Date {td} {td:class=methodParamName}Start_Date {td} {td:class=methodParamDesc}Start date for the query window {td} {tr} {tr} {td:class=methodParamType}Zend_Date {td} {td:class=methodParamName}End_Date {td} {td:class=methodParamDesc}End_Date for the query window {td} {tr} {tr} {td:class=methodParamType}Boolean {td} {td:class=methodParamName}with_children {td} {td:class=methodParamDesc}Include children? {td} {tr} {tr} {td:class=methodParamType}Integer {td} {td:class=methodParamName}Start {td} {td:class=methodParamDesc}Start at record # {td} {tr} {tr} {td:class=methodParamType}Integer {td} {td:class=methodParamName}End {td} {td:class=methodParamDesc}Return up to and including record # {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}filter {td} {td:class=methodParamDesc}Return records with string in the body {td} {tr} {tr} {td:class=methodParamType}Array {td} {td:class=methodParamName}ordercol {td} {td:class=methodParamDesc}The sorting for the structure {td} {tr} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[commPEResultType|commPEResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Returns the matching collection of actuals records {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2}NO_RECORDS {td} {td:class=methodErrorDesc}No records found {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:queryForecastSumm} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}queryForecastSumm {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Returns a summary of the forecast(scenario) information by gl {td} {tr} {tr} {th:class=h|rowspan=11}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}GL_HIER {td} {td:class=methodParamDesc}The gl_hierarchy to use {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}GL_Level {td} {td:class=methodParamDesc}The GL Category or Account to show items from {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}CoArray {td} {td:class=methodParamDesc}The cost_collector_key {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}Scenario_key {td} {td:class=methodParamDesc}The scenario key. Defaults to the Common scenario key (COMMON) {td} {tr} {tr} {td:class=methodParamType}Zend_Date {td} {td:class=methodParamName}Start_Date {td} {td:class=methodParamDesc}Start date for the query window {td} {tr} {tr} {td:class=methodParamType}Zend_Date {td} {td:class=methodParamName}End_Date {td} {td:class=methodParamDesc}End_Date for the query window {td} {tr} {tr} {td:class=methodParamType}Boolean {td} {td:class=methodParamName}with_children {td} {td:class=methodParamDesc}Include children? {td} {tr} {tr} {td:class=methodParamType}Integer {td} {td:class=methodParamName}Start {td} {td:class=methodParamDesc}Start at record # {td} {tr} {tr} {td:class=methodParamType}Integer {td} {td:class=methodParamName}End {td} {td:class=methodParamDesc}Return up to and including record # {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}filter {td} {td:class=methodParamDesc}Return records with string in the body {td} {tr} {tr} {td:class=methodParamType}Array {td} {td:class=methodParamName}ordercol {td} {td:class=methodParamDesc}The sorting for the structure {td} {tr} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[forSummResultType|forSummResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Returns the matching collection of actuals records {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2}NO_RECORDS {td} {td:class=methodErrorDesc}No records found {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:queryForecastPODetail} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}queryForecastPODetail {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Returns matching forecast (scenario) expense Records (rename?) {td} {tr} {tr} {th:class=h|rowspan=11}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}GL_HIER {td} {td:class=methodParamDesc}The gl_hierarchy to use {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}GL_Level {td} {td:class=methodParamDesc}The GL Category or Account to show items from {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}CoArray {td} {td:class=methodParamDesc}The cost_collector_key {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}Scenario_key {td} {td:class=methodParamDesc}The scenario key. Defaults to the Common scenario key (COMMON) {td} {tr} {tr} {td:class=methodParamType}Zend_Date {td} {td:class=methodParamName}Start_Date {td} {td:class=methodParamDesc}Start date for the query window {td} {tr} {tr} {td:class=methodParamType}Zend_Date {td} {td:class=methodParamName}End_Date {td} {td:class=methodParamDesc}End_Date for the query window {td} {tr} {tr} {td:class=methodParamType}Boolean {td} {td:class=methodParamName}with_children {td} {td:class=methodParamDesc}Include children? {td} {tr} {tr} {td:class=methodParamType}Integer {td} {td:class=methodParamName}Start {td} {td:class=methodParamDesc}Start at record # {td} {tr} {tr} {td:class=methodParamType}Integer {td} {td:class=methodParamName}End {td} {td:class=methodParamDesc}Return up to and including record # {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}filter {td} {td:class=methodParamDesc}Return records with string in the body {td} {tr} {tr} {td:class=methodParamType}Array {td} {td:class=methodParamName}ordercol {td} {td:class=methodParamDesc}The sorting for the structure {td} {tr} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[commPOResultType|commPOResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Returns the matching collection of actuals records {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2}NO_RECORDS {td} {td:class=methodErrorDesc}No records found {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
Anchor | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
Operations|#Operations] {anchor:queryForecastPEDetail} {table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}queryForecastPEDetail {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Returns matching forecast (scenario) personnel Records (rename?) {td} {tr} {tr} {th:class=h|rowspan=11}Parameters {th} {td:class=methodParamType}String {td} {td:class=methodParamName}GL_HIER {td} {td:class=methodParamDesc}The gl_hierarchy to use {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}GL_Level {td} {td:class=methodParamDesc}The GL Category or Account to show items from {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}CoArray {td} {td:class=methodParamDesc}The cost_collector_key {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}Scenario_key {td} {td:class=methodParamDesc}The scenario key. Defaults to the Common scenario key (COMMON) {td} {tr} {tr} {td:class=methodParamType}Zend_Date {td} {td:class=methodParamName}Start_Date {td} {td:class=methodParamDesc}Start date for the query window {td} {tr} {tr} {td:class=methodParamType}Zend_Date {td} {td:class=methodParamName}End_Date {td} {td:class=methodParamDesc}End_Date for the query window {td} {tr} {tr} {td:class=methodParamType}Boolean {td} {td:class=methodParamName}with_children {td} {td:class=methodParamDesc}Include children? {td} {tr} {tr} {td:class=methodParamType}Integer {td} {td:class=methodParamName}Start {td} {td:class=methodParamDesc}Start at record # {td} {tr} {tr} {td:class=methodParamType}Integer {td} {td:class=methodParamName}End {td} {td:class=methodParamDesc}Return up to and including record # {td} {tr} {tr} {td:class=methodParamType}String {td} {td:class=methodParamName}filter {td} {td:class=methodParamDesc}Return records with string in the body {td} {tr} {tr} {td:class=methodParamType}Array {td} {td:class=methodParamName}ordercol {td} {td:class=methodParamDesc}The sorting for the structure {td} {tr} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[commPEResultType|commPEResultTypeInfo Structure] {td} {td:class=methodReturnDesc} Returns the matching collection of actuals records {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2}NO_RECORDS {td} {td:class=methodErrorDesc}No records found {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table} [ |
...
...