OutSystems システム開発

【OutSystems】Forgeで拡張!Excelによる帳票の出力手順(導入編)

2020年2月29日

OutSystemsのExcel出力

 

OutSystemsでExcelを出力したいので、手順を教えて!

 

OutSystemsでは、標準機能でExcelの出力に対応しています。
ただし、標準機能のExcel出力は罫線や背景色といったレイアウトなどは何もない状態です。

そこで、Forgeという拡張機能を利用して、見栄えのいい帳票を出力しましょう。

今回は、導入編ということで「Forgeのインストール」、「Excelの出力」を解説します。

OutSystemsの拡張機能【Forge】

Forge

まずは、Forgeってなに?という方のためにちょっとだけ解説します。

Forgeとは、OutSystemsの標準機能では足りない部分を補うための拡張機能です。

例えば、このような機能が提供されています。

  • 画面に表示されている内容をPDFに変換
  • 標準機能で提供されている表のヘッダを固定
  • SSO認証(SAML認証)
  • Google Mapの表示機能
  • Excel出力機能

それでは、さっそくForgeのインストールを行いましょう。

Forgeは、僕が知っているだけでも2通りのインストール方法がありますが、今回は「Service Studio」からForgeをインストールしてみました。

Forge (Advanced Excel) をインストール

では、今回はExcelの出力ですので、「Advanced Excel」というForgeをインストールしてみましょう。

※Windows10にて実施しています。

Service StudioからForge(Advanced Excel)をインストール

WindowsのスタートメニューからService Studioを起動しましょう。

画像にそってインストールの手順を解説していきますね。

forge install
Service Studioの表示画面

「Install Application」をクリックします

ログイン画面

ログインします。

Forgeの検索画面

Forgeの画面が表示されますので、「excel」で検索し、「Advanced Excel」をクリックします。

Forge(Advanced Excel)の画面

赤いボタンの「INSTALL...」をクリックします。

Service Studioの表示画面

「Service Studio」上で「Advanced Excel」が表示されます。

これで、Forge(Advanced Excel)のインストールは完了です。すごく簡単ですね。

ブラウザからForgeをインストール

もう一つの方法は、ブラウザからインストールファイルをダウンロードして行います。

ブラウザからインストールする手順
  • ブラウザにて、OutSystemsのForgeの画面にアクセス
  • 目的のForgeを検索して、インストールファイルをダウンロード
  • ダウンロードしたファイルを実行

これだけで、自動的にForgeがインストールできます。どちらの手順も簡単ですね。

Forge(Advanced Excel)を使用してExcelを出力

Forgeはインストールした後は、アプリケーション側で準備が必要です。

え?インストールしただけでは使えないの?

そう思われる方もいると思います。

Forgeはかなりの種類が提供されているので、インストールした後にどれを使用するかをアプリケーション側で設定するようになっているのです。

では、アプリケーション側の設定を行っていきましょう。

Forgeを利用するためのアプリケーション側の設定

アプリケーション側の設定を行っていきましょう。
今回は、「Responsive App」で作成したアプリケーションを使用しています。

Service Studio上のビジュアルエディタ画面

コンセントのアイコンをクリックします。

Forge利用選択画面

・左のリストから「Advanced Excel」を選択

・右側の先頭のチェックボックスにチェックを入れる

・「APPLY」ボタンをクリックする。

これで、アプリケーション側の設定は完了です。
では、実際に「Advanced Excel」を使用してみましょう。

Forge(Advanced Excel)を使用してExcelを出力

今回は、新規作成したExcelに文字を出力するだけの簡単な方法を解説します。

今後の記事にて「Advanced Excel」の詳細な利用方法をまとめますのでお待ちください。

では、簡単なアプリケーションを用意します。

Main Flow画面

「MainFlow」をダブルクリックして、「Screen」をドラッグ&ドロップします。

表示された画面にて「Empty」を選択して画面を作成します。

※名前は何でも大丈夫です。

新規作成した画面

「Button」を画面にドラッグ&ドロップします。

配置した「Button」をダブルクリックします。

※このボタンをクリックすると、Excelがダウンロードされるように設定していきます。

追加したButtonの処理

「Run Server Action」をドラッグ&ドロップします。

追加したActionをダブルクリックします。

※このActionでは、ダウンロードするExcelのデータを作成します。

追加したActionの処理

図のようにActionを配置していきます。

詳細は次で解説します。

まずは、作成したActionに戻り値を設定します。

プロパティ

作成したActionに「Output Parameter」を追加して、「Data Type」に「Binary Data」を指定します。

では、一つずつActionを解説していきますね。

プロパティ

最初にブックを作成します。プロパティには何も設定しなくて大丈夫です。
この時にはまだシートが無い状態です。

プロパティ

ブックを作成した後に、シートを作成します。
プロパティでは「Workbook」に、先ほど作成したブックを設定します。
シート名は何でも大丈夫です。ここでは"NewSheet"としています。
「Worksheet」は新規作成しますのでNullObject()を設定します。

プロパティ

シートを作成した後に、使用するシートを選択します。
「Workbook」は先ほどと同じ設定です。
「WorksheetIndex」には、作成したシートを選択します。今回は1つのシートを作成しましたので1番目の「1」を設定します。
「WorksheetName」で、シート名を指定しても問題ありません。

プロパティ

シートを選択したら、セルを操作してみましょう。

「Worksheet」に選択したシートを設定します。
「CellName」か、「CellRow」と「CellColumn」のどちらかの組み合わせでセルの位置を設定します。「CellName」は"B3"などで設定できます。
今回は「CellRow」に「1」、「CellColumn」に「2」と設定します。
「CellValue」は値です。今回は"Test"と設定します。
「CellType」はセルの値の形式です。今回は文字列ですので"text"と設定します。

プロパティ

セルの編集が完了したら、ダウンロードするためのデータを取得します。
「Workbook」には、今回作成したブックを設定します。

プロパティ

ダウンロード用のデータを取得したら、ブックを閉じます。
「Workbook」には、閉じるブックを設定します。今回は作成したブックを指定しています。

プロパティ

ブックを閉じたら、戻り値に取得したダウンロード用のデータを設定します。

これでActionの作成は完了です。

最後に、ダウンロードする処理を作成しましょう。
作成したScreenに戻ります。

プロパティ

「End」の部分を「Download」に置き換えます。

プロパティの「File Content」にはActionで作成したデータを設定します。
「File Name」は何でも大丈夫です。今回は”ExcelTest.xlsx"としています。

出来たら「Publish」して、動かしてみましょう。

ダウンロードしたExcelがこのように表示されればOKです。
※今回はOpenOfficeで確認してみました。

今回は、これで解説は終わりです。ありがとうございました!

-OutSystems, システム開発
-, ,

Copyright© Mamito blog , 2020 All Rights Reserved Powered by AFFINGER5.