コマンドラインでのアプリの発行 | Forguncy 10 オンラインヘルプ

コマンドラインでのアプリの発行

このトピックで

Forguncyでは、コマンドラインから直接Forguncy Serverにアプリケーションを発行する機能を提供しています。この機能を使用することで、ユーザーはをForguncy Builderを使用せずにプロジェクトファイルやチーム開発プロジェクトからForguncyサーバーへアプリケーションを自動公開することができ、デリバリーの自動化や継続的なデリバリーでの運用が可能になります。

コマンドラインでの実行にはForguncy Builderのインストールプログラムに含まれる「ForguncyConsole.exe」を使用します。下記のフォルダーにインストールされます。

C:\Program Files\Forguncy <バージョン番号＞\Website\designerBin

Forguncy 10の場合
C:\Program Files\Forguncy 10\Website\designerBin

ForguncyConsole.exeの使い方を確認する

コマンドラインプログラムを開き以下のコマンドを入力し使い方を確認します。

Example Title	コードのコピー
C:\Program Files\Forguncy 10\Website\designerBin>ForguncyConsole /?

以下のコマンドでパラメータの詳細な説明を見ることもできます。

ForguncyConsole.exe Action=PublishToServer /help

プロジェクトファイルを発行する

プロジェクトファイルを指定した発行方法です。発行先等の設定情報は作成済みの発行プロファイルを指定します。

サンプルコード

Example Title	コードのコピー
ForguncyConsole.exe Action=PublishToServer File=C:\Users\Public\Documents\Document.fgcp PublishConfigName=PublishSetting1 ServerPassword=123456

パラメータの説明

パラメータ名	説明
File	［必須］Forguncyプロジェクト（*.fgcp）ファイルのパスを指定します。
PublishConfigName	［任意］発行に使用する発行プロファイルの名前を指定します。
ServerPassword	［必須］Forguncyサーバーのパスワードを指定します。発行プロファイルにはパスワードの情報は含まれないため、本パラメータを指定する必要があります。

CIツールのドキュメントフォルダから発行する

チーム開発プロジェクトの変更を検知した継続的インテグレーションおよび継続的デリバリーを行うような場合の発行方法です。継続的インテグレーションにはJenkinsやTeamCityなどのCIツールの使用を想定しています。

注意：CIツールがソースを生成するには、CIツールがForguncyチーム開発プロジェクトにアクセスするためのアドレス、認証のためのユーザー名、パスワードなどの情報が必要です。

本コマンドでは、CIツールによりダウンロードされたチーム開発プロジェクトファイルの出力フォルダーを指定して発行します。発行先等の設定情報は作成済みの発行プロファイルを指定します。

サンプルコード

Example Title	コードのコピー
ForguncyConsole.exe Action=PublishToServer Folder=./ PublishConfigName=PublishSetting1 ServerPassword=123456

パラメータの説明

パラメータ名	説明
Folder	［必須］Forguncyチーム開発プロジェクトのファイルが出力されたフォルダーを指定します。通常CIツールによって管理されています。
PublishConfigName	［任意］発行に使用する発行プロファイルの名前を指定します。
ServerPassword	［必須］Forguncyサーバーのパスワードを指定します。発行プロファイルにはパスワードの情報は含まれないため、本パラメータを指定する必要があります。

チーム開発プロジェクトから発行する

チーム開発プロジェクトを使用した発行方法です。ForguncyプロジェクトのGitリポジトリのURL、認証のためのユーザー名、パスワードを提供する必要があります。

サンプルコード（発行プロファイルを使用する場合）

Example Title	コードのコピー
ForguncyConsole.exe Action=PublishToServer RepoUrl=http://xx-xxx/Forguncy.Git.Server/Test.git RepoUserName=admin RepoPassword=pass PublishConfigName=PublishSetting1 ServerPassword=123456

サンプルコード（発行プロファイルを使用しない場合）

Example Title	コードのコピー
ForguncyConsole.exe Action=PublishToServer RepoUrl=http://xx-xxx/Forguncy.Git.Server/Test.git RepoUserName=admin RepoPassword=pass ServerName=forguncy-svr UserName=Administrator ServerPassword=123456 AppName=App1

Example Title

コードのコピー

ForguncyConsole.exe Action=PublishToServer RepoUrl=http://xx-xxx/Forguncy.Git.Server/Test.git RepoUserName=admin RepoPassword=pass ServerName=forguncy-svr UserName=Administrator ServerPassword=123456 AppName=App1

パラメータの説明

パラメータ名	説明
RepoUrl	［必須］チーム開発プロジェクトのGitリポジトリのURLを指定します。
RepoBranchName	［任意］チーム開発プロジェクトのブランチの名前、既定値は「master」です。
RepoUserName	［任意］チーム開発プロジェクトの認証に使用するユーザー名を指定します。使用中のコンピュータで既に認証が通っている場合やリポジトリに匿名アクセスが可能である場合は省略できます。
RepoPassword	［任意］チーム開発プロジェクトの認証に使用するパスワードを指定します。 RepoUserNameと同様、使用中のコンピュータで既に認証が通っている場合やリポジトリに匿名アクセスが可能である場合は省略できます。
PublishConfigName	［任意］発行に使用する発行プロファイルの名前を指定します。
ServerPassword	［必須］Forguncyサーバーのパスワードを指定します。発行プロファイルにはパスワードの情報は含まれないため、本パラメータを指定する必要があります。

その他の使用可能なパラメータ

コマンドラインからより多くのパラメータや値を表示できます。発行処理により多くの設定を渡すことができます。これらのパラメータのデフォルト値は、発行ダイアログのデフォルトオプションと同じ動作をします。

パラメータ名	説明	型	既定値
ServerName	発行先サーバーのホスト名またはIPアドレス	string	null
UserName	発行先サーバーへの認証に使用するユーザー名	string	administrator
SitePort	発行するアプリケーションのポート番号	string	null
AppName	発行するアプリケーションの名前	string	null
AppStartPage	発行するアプリケーションのデフォルトページ	string	プロジェクトの設定と同じ
Https	発行するアプリケーションのSSL使用（HTTPSでの利用）するかどうか	bool	false
PublishRolesToServer	Forguncy Builder側のロール情報を発行するかどうか	bool	true
PublishUsersToServer	Forguncy Builder側のユーザー情報を発行するかどうか	bool	false
PublishOrganizationsToServer	Forguncy Builder側の組織情報をForguncy Serverに発行するかどうか	bool	false
OverrideBuiltinDatabase	Forguncy Server側の内部データベースの情報を上書きするかどうか	bool	false
OverrideProcessDatabaseToServer	Forguncy Server側のワークフロー設定を上書きするかどうか	bool	false
OverridePageAuthorityToServer	ページの権限とセルの権限を上書きするかどうか	bool	false
OverrideServerScheduleTask	Forguncy Server側のスケジュールタスクを上書きするかどうか	bool	false
OverrideServerGlobalProperty	グローバル変数を上書きするかどうか	bool	false

戻り値（エラーコード）

発行処理中にエラーが発生した場合、0以外の値（エラーコード）がコンソール画面に返されます。エラーコードの内容はコンソール画面にも出力され確認できます。

戻り値	エラーの原因	解決策
0	成功
1000	コマンドラインの引数が不足しています	不足しているコマンドラインの引数を追加してください
1001	コマンドラインの引数が不正です	コマンドラインの引数に正しい値を設定してください
1010	コマンドライン引数にFileが不足しています	コマンドライン引数にFileを追加してください
1011	指定されたファイルが存在しません	存在する正しいプロジェクトファイルを指定してください
1012	コマンドライン引数にFolderが不足しています	コマンドライン引数にFolderを追加してください
1013	指定されたフォルダが見つかりません	存在する正しいフォルダを指定してください
1020	指定された発行プロファイルが存在しません	発行プロファイルを作成し指定するか、または存在する発行プロファイルを指定してください
1021	コマンドラインの引数にServerPasswordが不足しています	コマンドライン引数にServerPasswordを追加してください
1030	コマンドライン引数にRepoUrlが不足しています	コマンドライン引数にRepoUrlパラメータを追加してください
2000	指定されたチーム開発プロジェクトのオープンに失敗しました	指定したチーム開発プロジェクトが有効かどうかを確認してください
2001	指定されたフォルダのプロジェクトのオープンに失敗しました	チームの開発プロジェクトまたはCIツール側の設定が有効かどうかを確認してください
2002	指定されたプロジェクトファイルのオープンに失敗しました	プロジェクトファイルが有効かどうかを確認してください
2010	プロジェクトファイルにエラーが見つかりました。例）プロジェクト内に無効な数式の参照がある、リストビューが削除された、など。	Forguncy Builderでプロジェクトのエラーを修正してください
2011	アプリケーションの生成で予期せぬエラーが発生しました	Forguncy Builderからプロジェクトが正しく発行できるか確認してください
2012	発行プロファイルや発行設定のチェックに失敗しました例）指定したホスト名で接続できない、ユーザ名やパスワードが間違ってる、など。	発行プロファイルを確認し正しい値を設定してください
2013	発行中に予期せぬエラーが発生しました例）ネットワークの切断、サーバーのダウン、など。	サーバーやネットワーク環境に問題がないかを確認してください。また、Forguncy Builderからプロジェクトが正しく発行できるかを確認してください