TaskRunner 物件

TaskRunner 提供一種方便的方式來同步建立及執行作業。

t.createStream(name ， autoConnect， autoManage): 串流

name (string) : 物件的名稱

autoConnect (boolean) : 是否應該將串流自動連接至伺服器

autoManage (boolean) : 是否應該將串流新增至串流管理程式

建立並傳回新的 Stream。 請注意，需要私下建立串流而不讓使用者看見這些串流的程式碼應該將 autoManage 旗標設定為 False。

異常狀況：

ServerConnectionException : ，如果階段作業已連接且自動連接旗標為 True ，但無法為串流建立新的連線

t.exportDocumentToFile(documentOutput，檔名， fileFormat)

documentOutput (DocumentOutput) : 要匯出的文件

filename (string) : 匯出的檔案路徑

fileFormat (FileFormat) : 匯出檔格式

使用指定的檔案格式將串流說明匯出至檔案。

異常狀況：

OwnerException : 如果文件不是由作業執行程式階段作業所擁有

SessionException : ，如果因為某些原因而無法匯出文件

ExportFormatException : 如果文件不支援匯出格式

t.exportModelSummaryToFile(modelOutput， filename ， fileFormat)

modelOutput (ModelOutput) : 要匯出的模型

filename (string) : 匯出的檔案路徑

fileFormat (FileFormat) : 匯出檔格式為 FileFormat.PLAIN_TEXT 或 FileFormat.HTML。

使用指定的檔案格式將模型摘要匯出至檔案。 模型摘要只能匯出為文字或 HTML。

異常狀況：

OwnerException : ，如果模型不是由作業執行程式階段作業所擁有

SessionException : ，如果因為某些原因而無法匯出模型

ExportFormatException : (如果模型不支援匯出格式)

t.exportModelSummaryToFile(node ， filename ， fileFormat)

modelOutput (Node) : 要匯出的模型套用者節點

filename (string) : 匯出的檔案路徑

fileFormat (FileFormat) : 匯出檔格式為 FileFormat.PLAIN_TEXT 或 FileFormat.HTML。

使用指定的檔案格式，將所提供節點中的模型摘要匯出至檔案。 模型摘要只能匯出為文字或 HTML。

異常狀況：

OwnerException : ，如果模型不是由作業執行程式階段作業所擁有

SessionException : ，如果因為某些原因而無法匯出模型

ExportFormatException : (如果模型不支援匯出格式)

t.exportModelToFile(modelOutput， filename ， fileFormat)

modelOutput (ModelOutput) : 要匯出的模型

filename (string) : 匯出的檔案路徑

fileFormat (FileFormat) : 匯出檔格式

使用指定的檔案格式將模型匯出至檔案。

異常狀況：

OwnerException : ，如果模型不是由作業執行程式階段作業所擁有

SessionException : ，如果因為某些原因而無法匯出模型

ExportFormatException : (如果模型不支援匯出格式)

t.exportModelToFile(node ， filename ， fileFormat)

modelOutput (Node) : 要匯出的模型套用者節點

filename (string) : 匯出的檔案路徑

fileFormat (FileFormat) : 匯出檔格式

使用指定的檔案格式，將所提供節點中的模型匯出至檔案。

異常狀況：

OwnerException : ，如果模型不是由作業執行程式階段作業所擁有

SessionException : ，如果因為某些原因而無法匯出模型

ExportFormatException : (如果模型不支援匯出格式)

t.exportOutputToFile(物件、檔名、 fileFormat、選項)

object (PropertiedObject) : 具有輸出內容的物件

filename (string) : 應該將輸出匯出至其中的檔名

fileFormat (FileFormat) : 檔案格式

options (Map) : 「無」或屬性值的雜湊表

將所提供物件的輸出內容匯出至指定的檔案和格式。 支援下列文件格式:

  • FileFormat.PLAIN_TEXT
  • FileFormat.HTML
  • FileFormat.RTF
  • FileFormat.SPV
  • FileFormat.SPW
  • FileFormat.SPSS_WEB_REPORT
  • FileFormat.COGNOS_ACTIVE_REPORT
  • FileFormat.PDF
  • FileFormat.MS_EXCEL
  • FileFormat.MS_EXCEL2007
  • FileFormat.MS_EXCEL2007_M
  • FileFormat.MS_POWERPOINT

支援下列影像格式:

  • FileFormat.BITMAP
  • FileFormat.PNG
  • FileFormat.JPEG
  • FileFormat.TIFF

如果提供 options ，則值是屬性/值配對的表格。 若為文件匯出，選項如下:

  • alternate_log_file_location (字串): 日誌檔的位置 (如果要個別匯出的話)
  • custom_report_title (字串) :Web 報告的自訂標題
  • excel_location_option ("AddColumns" ， "AddRows" ， "OverwriteAtCellRef"): 其中內容應該在 Excel 中匯出至
  • excel_operation_option ("CreateWorkbook" ， "CreateWorksheet" ， "ModifyWorksheet"): 如何將內容匯出至 Excel
  • excel_sheetname (字串) :Excel 工作表名稱
  • excel_starting_cell_ref (字串) :Excel 開始儲存格參照
  • export_html_headers (布林): 是否匯出 HTML 標頭
  • export_image_maps (布林): 是否建立影像鏈結圖
  • export_images (布林): 對於不支援影像的格式，是否應個別匯出影像
  • html_with_style (布林): 是否應儲存樣式資訊
  • include_footnotes_and_captions (布林): 是否應包含註腳和標題
  • interactive_layer (布林): 互動式層是否應包含在支援它們的格式中
  • is_logs_excluded (布林): 是否排除日誌
  • is_notes_excluded (布林): 是否排除附註
  • is_text_excluded (布林): 是否排除文字內容
  • javascript_file_name (字串): 對於互動式輸出， JavaScript 檔的位置 (如果有個別的話)
  • model_view_option ("MVExportAll" ， "MVExportVisible" ， "MVPrintSetting"): 應該匯出哪些模型視圖
  • page_break_between_table (布林): 是否在表格之間建立分頁
  • page_setup (對映): 頁面設定設定 (請參閱下面的說明)
  • pdf_embed_bookmarks (布林): 是否在 PDF 文件中內嵌書籤
  • pdf_embed_fonts (布林): 是否在 PDF 文件中嵌入字型
  • pivot_table_option ("PTExportAllLayers" ， "PTExportVisibleLayers" ， "PTUsePrintLayerSetting"): 應如何處理樞紐表
  • ppt_use_viewer_outlines (布林): 是否在 PowerPoint 中使用檢視器大綱
  • preserve_break_points (布林): 是否保留岔斷點
  • table_style (字串): 表格樣式的名稱
  • text_encoding ("utf8" ， "utf16"): 要在文字檔中使用的文字編碼
  • text_doc_option ("TxtUsespaces" ， "TxtUseTab"): 是否在文字檔中使用空格或定位點
  • text_width_autofit (布林): 是否讓表格直欄符合文字檔中的內容
  • txt_column_width (整數): 如果表格直欄不適合其在文字檔中的內容，則定義欄寬
  • col_txt_border_character (字元): 匯出至文字檔時的表格直欄字元
  • row_txt_border_character (字元): 匯出至文字檔時的表格直欄字元
  • viewer_doc_name (字串): 應顯示在檢視器中的文件名稱
  • wide_tables_option ("WT_Extend" ， "WT_Shrink" ， "WT_Wrap"): 定義應如何處理寬表格

對於圖形匯出，選項如下:

  • bmp_compress_image (布林): 是否壓縮點陣圖影像
  • graph_image_size (整數): 將匯出的影像調整為原始影像的百分比
  • graph_invert_colors (布林): 是否反轉顏色
  • graph_type ("BMP" ， "JPG" ， "PNG" ， "TIF"): 定義從非影像內容個別匯出影像時要使用的圖形類型
  • model_view_option ("MVExportAll" ， "MVExportVisible" ， "MVPrintSetting"): 應該匯出哪些模型視圖
  • png_color_depth ("BlackWhite"、"Grays"、"SixteenColors"、"TrueColor24"、"TrueColor36"、"TwoFiftySixColors"): 匯出至 PNG 時的顏色深度
  • tiff_color_space ("CMYK" ， "RGB"): 匯出至 TIF 時的顏色空間
  • tiff_compress_image (布林): 是否壓縮 TIF 影像

對於 page_setup，選項如下:

  • height (倍精準數): 頁面高度
  • width (倍精準數): 頁面寬度
  • bottom_margin (倍精準數): 下邊距
  • left_margin (倍精準數): 左邊距
  • right_margin (倍精準數): 右邊距
  • top_margin (倍精準數): 上邊距
  • orientation (整數): 0 代表直印， 1 代表橫印
  • units ("公分"、"公釐"、"英吋"、"PrintPoints"): 邊距及維度值所代表的單位

異常狀況：

OwnerException : 如果物件不是由現行階段作業所擁有

ExportFormatException : (如果不支援匯出格式)

SessionException : (如果發生其他錯誤)

t.exportStreamToFile(串流、檔名、 fileFormat)

stream (Stream) : 要匯出的串流

filename (string) : 匯出的檔案路徑

fileFormat (FileFormat) : 匯出檔格式

使用指定的檔案格式將串流說明匯出至檔案。

異常狀況：

OwnerException : 如果串流不是由作業執行程式階段作業所擁有

SessionException : ，如果由於某些原因而無法匯出串流

ExportFormatException : (如果串流不支援匯出格式)

t.insertNodeFromFile(檔名，圖表): 節點

filename (string) : 檔案路徑

diagram (Diagram) : 應該插入節點的圖表

從指定檔案中讀取並傳回節點，然後將其插入所提供的圖中。 請注意，這可用來讀取 Node 和 SuperNode 物件。

異常狀況：

OwnerException : 如果圖表不是由作業執行程式階段作業所擁有

SessionException : ，如果節點因某些原因而無法載入

ObjectLockedException : (如果要在其中新增節點的串流已鎖定)

t.openDocumentFromFile(檔名， autoManage): DocumentOutput

filename (string) : 文件檔案路徑

autoManage (boolean) : 是否應該將文件新增至輸出管理程式

從指定檔案讀取並傳回文件。

異常狀況：

SessionException : 如果因為某些原因而無法載入文件

t.openModelFromFile(檔名， autoManage): ModelOutput

filename (string) : 模型檔路徑

autoManage (boolean) : 是否應該將模型新增至模型管理程式

從指定檔案讀取並傳回模型。

異常狀況：

SessionException : ，如果因為某些原因而無法載入模型

t.openStreamFromFile(檔名， autoManage): 串流

filename (string) : 串流檔路徑

autoManage (boolean) : 是否應該將串流新增至串流管理程式

從指定檔案讀取並傳回串流。

異常狀況：

SessionException : (如果因為某些原因而無法載入串流)

t.saveDocumentToFile(documentOutput， filename)

documentOutput (DocumentOutput) : 要儲存的文件

filename (string) : 文件檔案路徑

將文件儲存到指定的檔案位置。

異常狀況：

OwnerException : 如果文件不是由作業執行程式階段作業所擁有

SessionException : 如果因為某些原因而無法儲存文件

t.saveModelToFile(modelOutput，檔名)

modelOutput (ModelOutput) : 要儲存的模型

filename (string) : 模型檔路徑

將模型儲存到指定的檔案位置。

異常狀況：

OwnerException : ，如果模型不是由作業執行程式階段作業所擁有

SessionException : ，如果因為某些原因而無法儲存模型

t.saveNodeToFile(node ， filename)

node (Node) : 要儲存的節點

filename (string) : 節點檔案路徑

將模型儲存到指定的檔案位置。

異常狀況：

OwnerException : 如果節點不是由作業執行程式階段作業所擁有

SessionException : (如果節點因某些原因而無法儲存)

t.saveStreamToFile(串流，檔名)

stream (Stream) : 要儲存的串流

filename (string) : 串流檔路徑

將串流儲存到指定的檔案位置。

異常狀況：

OwnerException : 如果串流不是由作業執行程式階段作業所擁有

SessionException : ，如果因為某些原因而無法儲存串流