« Importing Data Using Forms   |   Exporting Data Using Forms »

CALCULATE_BY_FORM - Executing Calculations Using Forms

This manual is in pilot operation.

This function retrieves ledger data via a form, performs calculations according to the form’s calculation formulas, and reflects the data of cells marked "reflect calculation results to ledger" in the form’s column/row or cell specifications back to the ledger.

Request Type

CALCULATE_BY_FORM

How to Write a Request

Below is an example request for "Executing Calculations Using Forms":

<request type="CALCULATE_BY_FORM" desc="Execute Calculation">
  <parameters>
    <parameter name="APPLICATION" value="SAMPLE1"/> (1)
    <parameter name="FORM" value="IMPORT_ACT1"/> (2)
    <parameter name="PARTICIPANT" value="#NONE"/> (3)
    <parameter name="POV" key="#FY" value="FY2015"/> (4)
  </parameters>
  <contents> (5)
  </contents>
</request>
1 "Application" parameter
2 "Form" parameter
3 "Participant" parameter
4 "Data POV" parameter
5 Request content

Parameters

Specify the same items as when displaying data using forms via fusion_place [Browser].

Parameter Required Key Description

APPLICATION

Yes

None

Specify the label of the target application.

LEDGER_EDITION

No

None

Specify the ledger edition key to be used. If omitted, "workspace" is assumed as the source. Reserved ledger keys are:

PUBLIC: Public edition
WORKSPACE: Common workspace edition

FORM

Yes

None

Specify the label of the form to be used for calculation.

PARTICIPANT

Yes

None

Specify the label of the participant selected during calculation. For workgroup applications, specify #NONE.

POV

No

Yes

Specify the parameter (POV) member for the form. Specify the dimension label in the key attribute and the member label in the value attribute.

All dimensions specified as parameters in the form require a POV specification.

Request Content

There is no "Request Content".

Response Content

Below is an example response for "Executing Calculations Using Forms":

<response type="CALCULATE_BY_FORM" desc="Execute Calculation">
  <returned-contents> (1)
  </returned-contents>
  <result>
    <code>SUCCESSFUL</code> (2)
    <started-at time-zone="Asia/Tokyo">2015/02/28 09:50:04.227</started-at>
    <ended-at time-zone="Asia/Tokyo">2015/02/28 09:50:07.827</ended-at>
    <messages> (3)
    </messages>
  </result>
</response>
1 Returned Content
2 Processing Result Code
3 Message

Returned Content

There is no returned content.

Message

If the processing result code is SUCCESSFUL, nothing is displayed in the message field.

If the processing result code is FAILED, the message field displays the reason for the failure.

No other processing result codes are used.

Language Application

English is always applied, as variations in calculation results due to language selection are undesirable.