EssImport

様々なソースからEssbaseサーバーへのデータのインポートを許可します。

構文

            ESS_FUNC_M EssImport (
            hCtx, pRules, pData, ppMbrErr, pMbrUser, abortOnError
            );

パラメータ	データ型	説明
hCtx	ESS_HCTX_T	APIコンテキスト・ハンドル。
pRules	ESS_OBJDEF_T	ルール・ファイル・オブジェクト定義構造体へのポインタ。
pData	ESS_OBJDEF_T	データ・ファイル・オブジェクト定義構造体へのポインタ。
ppMbrErr	ESS_MBRERR_T	ESS_MBRERR_Tに含まれるエラーのリンク・リストへのポインタ。考えられるエラーは次のとおりです: ESS_MBRERR_BADDIM ESS_MBRERR_BADGEN ESS_MBRERR_UNKNOWN ESS_MBRERR_BADACCESS ESS_MBRERR_BADSYNTAX
pMbrUser	ESS_MBRUSER_T	SQLユーザー構造体へのポインタ(データ・ソースがSQLデータベースの場合)。SQLユーザー構造体がNULLの場合は、SQL以外のデータ・ソースを示します。
abortOnError	ESS_USHORT_T	TRUEの場合、最初のエラーでインポートが停止します。それ以外の場合は続行します。

備考

SQLソース以外では、pRulesおよびpDataのESS_OBJDEF_T構造体のAppNameおよびDbNameフィールドがNULLである場合は、hCtxにローカル・コンテキスト・ハンドルを指定し、ESS_OBJDEF_TのFileNameフィールドにはファイルへの完全修飾パスを指定する必要があります。
ローカル・オブジェクトが使用される場合は、EssCreateLocalContextを最初に呼び出す必要があります。
ppMbrErrに対して割り当てられたメモリーは、EssFreeMbrErrを使用して解放する必要があります。

戻り値

正常終了の場合は0が戻されます。それ以外の場合、エラー・コードが戻されます。

アクセス

この関数を使用するには、呼出し元が、指定したデータベースに対するデータベース・デザイナ権限(ESS_PRIV_DBDESIGN)を持っている必要があります。

例

         ESS_FUNC_M
ESS_Import(ESS_HCTX_T hCtx)
{
   ESS_FUNC_M     sts = ESS_STS_NOERR;
   ESS_SHORT_T   isAbortOnError;
   ESS_OBJDEF_T  Rules;
   ESS_OBJDEF_T  Data;
   ESS_MBRUSER_T User;                 
   ESS_PMBRERR_T pMbrErr = NULL;
      
   Data.hCtx      = hCtx;
   Data.AppName   = "Olap";
   Data.DbName    = "Demo";
   Data.ObjType   = ESS_OBJTYPE_TEXT;   
   Data.FileName  = "Actuals";          
   
   Rules.hCtx     = hCtx;
   Rules.AppName  = "Olap";
   Rules.DbName   = "Demo";
   Rules.ObjType  = ESS_OBJTYPE_RULES;     
   Rules.FileName = "Actmap";           
   /**********************/   
   /* Running conditions */
   /**********************/
   isAbortOnError = ESS_TRUE;
   
   sts = EssImport (hCtx, &Rules, &Data, &pMbrErr,
         NULL, isAbortOnError);
   if(pMbrErr)
      EssFreeMbrErr(hCtx, pMbrErr);
   /*******************************************************************/
   /*                                                                 */
   /* When a SQL data source is defined in the rules file, define     */
   /* the variables in the ESS_OBJDEF_T Data structure as follows:    */
   /*    Data.hCtx     = hCtx;                                        */
   /*    Data.AppName  = NULL;                                        */
   /*    Data.DbName   = NULL;                                        */
   /*    Data.ObjType  = ESS_OBJTYPE_NONE;                            */
   /*    Data.FileName = NULL;                                        */
   /*                                                                 */
   /* Also, provide strings for the variables in the ESS_MBRUSER_T    */
   /* User structure; for example:                                    */
   /*    User.User     = "Dbusernm";                                  */
   /*    User.Password = "Dbpasswd";                                  */
   /*                                                                 */
   /* Use a blank string for User and Password, if the SQL source     */ 
   /* does not require user and password information; for example:    */
   /*    User.User     = "";                                          */
   /*    User.Password = "";                                          */
   /*                                                                 */
   /* Also, define sts as follows:                                    */
   /*    sts =  EssImport (hCtx, &Rules, &Data, &pMbrErr,             */
   /*           &User, isAbortOnError);                               */
   /*                                                                 */
   /*******************************************************************/ 
}