Importing Application Template

extreme Designer
This manual is in pilot operation.

(fusion_place >= 11.1)

The content of this page pertains to a version under development and may change without notice in terms of specifications, target version, and more.
This feature is limited to extreme licenses.

Imports the application template, i.e., all design objects included in an application, into the application. Only users authorized as Designer can execute this request.

Application templates can be exported via Exporting Application Template.

When importing an application template, objects and data other than design objects in the destination application may be lost. For example, if a scenario existed in the destination application but not in the application template, the data of that scenario will be deleted. Such cases can be identified by the processing result code WARNED.

To prepare for such cases, it is recommended to back up the destination application before importing the application template.

How to Write a Request

Below is an example request for "Importing Application Template":

<request type="IMPORT_APPLICATION_TEMPLATE" desc="Importing Application Template">
  <parameters>
    <parameter name="APPLICATION" value="SAMPLE1"/> (1)
  </parameters>
  <contents> (2)
    1f8b080...
  </contents>
</request>
1 "Application" parameter
2 Request content is the application template expressed in hexadecimal format. Application templates can be exported via Exporting Application Template.

Parameters

Specify the target application.

Parameter Key Description

APPLICATION Required

None

Specify the label of the target application.

Request Content

There is no specific request content.

Response Content

Below is an example response for "Importing Application Template":

<response type="IMPORT_APPLICATION_TEMPLATE" desc="Importing Application Template">
  <returned-contents> (1)
    1f8b080...
  </returned-contents>
  <result>
    <code>WARNED</code> (2)
    <started-at time-zone="Asia/Tokyo">2021/01/28 09:50:04.227</started-at>
    <ended-at time-zone="Asia/Tokyo">2021/01/28 09:50:07.827</ended-at>
    <messages>
      Since scenario "Forecast (FCST)" was deleted, its data was removed from the ledger if it existed. (3)
    </messages>
  </result>
</response>
1 Returned Content
2 Processing Result Code
3 Message

Returned Content

There is no returned content.

Processing Result Code

If the process completes without issues, the result will be SUCCESSFUL or WARNED.

WARNED indicates that while the process itself completed successfully, objects or data other than design objects were lost during the import of the application template. In the example above, the scenario Forecast (FCST) existed in the destination application but was not included in the application template, so it was deleted. Such occurrences may happen when the template design changes and are not necessarily problematic, but the result code is set to WARNED as a caution.

Message

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

If the result code is anything other than SUCCESSFUL, a message is displayed indicating the warning or error details.