« Importing Submission Routes   |   CALCULATE_BY_FORM - Executing Calculations Using Forms »

Importing Data Using Forms

This manual is in pilot operation.

Overview

This function imports data into the ledger following the import specifications of a form, similar to "Importing Data" performed via fusion_place [Browser]. Specifically, it imports data into the ledger through a specified form, data POV, and participant. Note that even if the form’s column/row or cell specifications indicate "reflect calculation results to ledger," this function does not perform that reflection.

How to Write a Request

Below is an example request for "Importing Data Using Forms":

<request type="IMPORT_VALUES" desc="Actual Import A">
  <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)
    <parameter name="FORMAT" value="csv"/> (5)
    <parameter name="NEWLINE_STYLE" value="lf"/> (6)
  </parameters>
  <contents>
    FY2015,M1,S01,M01,PL1100,-5131123 (7)
    FY2015,M2,S01,M01,PL1100,-11224332
    ....
  </contents>
</request>
1 "Application" parameter
2 "Form" parameter
3 "Participant" parameter
4 "Data POV" parameter
5 "Format" parameter
6 "Newline Style" parameter
7 Request content

Parameters

Specify the same items as when displaying data using forms via fusion_place [Browser] (note that FORMAT ,NEWLINE_STYLE cannot be specified via [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 import.

PARTICIPANT

Yes

None

Specify the label of the participant selected during import. 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.

MIN_SEVERITY

No

None

Specifies the severity level of log data output in the import log. Only lines with a severity equal to or higher than this level will be logged. If omitted, all log data lines are output.

Severity levels in descending order are:

ERROR
WARNING
INFO

FORMAT
(fusion_place >= 14.1)

No

None

Specifies the format of the request and returned contents. If omitted, csv is assumed.

Possible formats:

csv: Comma-separated
tsv: Tab-separated

NEWLINE_STYLE
(fusion_place >= 14.1)

No

None

Specifies the newline style for the returned contents. If omitted, lf is assumed.

Possible newline styles:

lf: Line feed (0x0A)
crlf: Carriage return (0x0D) + Line feed (0x0A)

Request Content

The request content consists of the data to be imported. The format is the same as when importing via fusion_place [Browser] (however, replacing special characters <, >, & is required).

Depending on whether the form is simple or full-featured, refer to the following for details:

Importable File Format (Simple Forms)

Importable File Format (Full-featured Forms)

Response Content

Below is an example response for "Importing Data Using Forms":

<response type="IMPORT_VALUES" desc="Actual Import A">
  <returned-contents>
    #LINE_NO, #BEFORE_AFTER, #FY, #PERIOD, TENPO, SHOHIN, #ACCOUNT, .... (1)
    3, "1.BEFORE", "FY2015", "M1", "S01", "M01", "PL1100", ...
    3,"2.AFTER","FY2015","M1","S01","M01","PL1100",...
    ....
  </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>
      Total count       : 693 (3)
      Skipped count     : 0
      Warning count     : 0
      Error count       : 0
    </messages>
  </result>
</response>
1 Returned content
2 Processing result code
3 Message

Returned Content

The returned content is the "Import Log." The format is the same as when importing via fusion_place [Browser] (with special characters <, >, & replaced).

Refer to: Import Log

Message

If the processing result code is not "FAILED," the message field displays the processing counts, with meanings identical to importing via fusion_place [Browser].

Refer to: Importing Data

If the result code is "FAILED," the message field shows the reason for the failure.