Exporting Data Using Forms

This manual is in pilot operation.

Overview

This function is the same as Exporting Data performed via fusion_place [Browser]. It exports ledger data via a form in CSV format, based on specified form, data POV, and participant.

How to Write a Request

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

<request type="EXPORT_VALUES" desc="Actual Export 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)
    <parameter name="QUOTE_STYLE" value="always"/> (7)
  </parameters>
  <contents> (8)
  </contents>
</request>
1 "Application" parameter
2 "Form" parameter
3 "Participant" parameter
4 "Data POV" parameter
5 "Format" parameter
6 "Newline Style" parameter
7 "Quote Style" parameter
8 No request content needed

Parameters

Specify the same items as when displaying data using forms via fusion_place [Browser] (except MIN_SEVERITY, which 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 use. If omitted, the "workspace" edition is used. Reserved keys are:

PUBLIC

Public Edition

WORKSPACE

Workspace Edition

FORM

Yes

None

Specify the label of the form used for export.

PARTICIPANT

Yes

None

Specify the label of the participant selected at export. For workgroup applications, specify #NONE.

POV

No

Yes

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

All dimensions set as form parameters must be specified.

FORMAT
(fusion_place >= 14.1)

No

None

Specifies the format of the returned content. If omitted, csv is used.

Available formats:

csv Comma-separated
tsv Tab-separated

NEWLINE_STYLE
(fusion_place >= 14.1)

No

None

Specifies the newline style of the returned content. If omitted, lf is used.

Available newline styles:

lf Line Feed (0x0A)
crlf Carriage Return (0x0D) + Line Feed (0x0A)

QUOTE_STYLE
(fusion_place >= 14.1)

No

None

Specifies the quoting style for the returned content. If omitted, it is treated as always.

Available quoting styles:

always Encloses all values in quotes ("). If the value contains ", it is replaced with "".

never No values are quoted. If the value contains ", ,, CR, LF, or tab, they are replaced with ?.

tsv (fusion_place >= 14.2.2) No values are quoted. If the value contains CR, LF, or tab, they are replaced with ?. When this value is specified, the output will be tab-separated, regardless of the FORMAT parameter.

Request Content

There is no "Request Content".

Response Content

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

<response type="EXPORT_VALUES" desc="Actual Export A">
  <returned-contents>
    "","FY2015 M12","FY2010 M12","Year-over-Year Diff","YoY (%)" (1)
    " Revenue[PL_SAL]", "0", "3245.94", "3245.94", "#DIV/0!"
    " Cost of Goods Sold[PL_COS]", "0", "2042.64", "2042.64", "#DIV/0!"
    " Gross Profit[PL_GRM]", "0", "1203.3", "1203.3", "#DIV/0!"
    <!-- ... -->
  </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

The returned content is the exported data. The format is the same as when exporting via fusion_place [Browser] (special characters <, >, & are replaced). For details, refer to:

Message

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

Language Application

When executed via Requester, the language specified in the parameters is applied. When executed via [Web-API], the language specified in the Accept-Language header is applied. If not specified, the server’s default language is used.