この考察ではこれまでのところ、すべてのプログラムに共通のAPIの側面について検討してきました。プログラムが行うよう設計されている操作については、まだ説明していません。プログラムはすべて、ネストされたプログラミング・モデルを理解し、API関数間で引数を一貫した方法で渡し、関数の戻りコードを解釈し、APIを初期化し、サーバーにログインし、データベースに接続し、ログアウトして、終了することを要求します。ここでは、プログラムの実際の要点について説明する必要があります。プログラムは、なんらかの操作を実行する必要があるのです。
この考察では、CのメインAPIの主要機能グループを扱います。いくつかのセクションは、サンプル・プログラムを取り上げますが、サンプル・プログラムが、APIのすべての領域を含んでいるとはかぎりません。サンプル・プログラムは、データをロードし、データベースのコンテンツをレポートし、更新および計算を実行して、データの新しいステータスをレポートします。コード内のコメントは、追加の操作を実行するために関数を今後追加できる場所を示します。
APIが実行できる操作のタイプの概要を知るためには、CのメインAPI関数のカテゴリおよびVisual BasicのメインAPI関数のカテゴリを参照してください。CのメインAPIには、ほぼ200個の関数があり、20の機能グループに分かれています。つまり、APIが実行できる操作は多岐に及びます。CのアウトラインAPI (78個の関数)およびグリッドAPI (59個の関数)は、APIプログラムをさらに複雑にできることを示します。サンプル・プログラムは、できるだけ簡単にする必要があります。したがって、CのメインAPIから少数の関数のみを使用し、アウトラインAPIまたはグリッドAPIはまったく使用していません。
サンプル・プログラムは、Essbaseに付属のSample Basicデータベースを使用します。このデータベースは、空の状態で提供されており、データをロードする必要があります。データは、CALCDAT.TXTという名前のテキスト・ファイルで提供されています。サンプル・プログラムは、あらかじめ構成された計算スクリプトおよびレポート・スクリプトを使用します。これらのプログラムが使用するログイン情報(サーバー名、アプリケーション名、データベース名、ユーザー名およびパスワード)は、プログラムにハードコードされています。プログラムはログイン・ダイアログ・ボックスを表示しますが、フィールドはすべて記入されています。ユーザーは、ダイアログ・ボックスに対して「OK」をクリックするのみです。サーバー名は"LocalHost"です。アプリケーション名は"Sample"です。データベース名は"Basic"です。ユーザー名は"admin"で、パスワードは"password"です。
プログラムをアセンブルする方法について説明するトピック: