CEA 的 wsadmin (Jython) Scripting 程序
「啟用通訊的應用程式 (CEA)」範例套件包含 wsadmin (Jython) Script 程式庫，可簡化 Script 的開發和測試，以自動化相關的配置變更。 Script 程式庫以範例形式提供，因此 IBM® 沒有義務提供維護、支援、更新、加強功能或修改。
Script 程式庫檔案 AdminCEA.py 位於 CEA 範例套件的 scripts 目錄中。 請參閱文件中的「範例」一節，以取得取得 CEA 範例套件的指示。
AdminCEA.py Script 程式庫檔案包含下列程序，可用來管理 CEA 設定:
AdminCEA.py 檔也包含下列程序，可用來管理 SIP 應用程式路由器:
將 AdminCEA.py 新增至 WebSphere Application Server
若要將 AdminCEA.py 新增至 WebSphere® Application Server，請完成下列動作:
- 建立下列目錄：
app_server_root/scriptLibraries/communications/V80 - 將 AdminCEA.py 檔複製到您在前一個步驟中建立的目錄。 下次啟動 wsadmin 時，會自動將新的程序提供給 wsadmin 指令 Shell。
使用程序
如果要使用下列一或多個程序，請從 Script 內呼叫適當的程序; 例如:
AdminCEA.moveServerToCustomRouter("localhostNode01", "server1", "RouterOne") 配置 CEA 設定的程序
showCEASettingsForCell
使用此程序來顯示 CEA 通訊服務應用程式的環境定義根目錄及虛擬主機。 使用 configureCEASettingsForCell 程序來瞭解每一個設定。
語法
showCEASettingsForCell()範例用法
showCEASettingsForCell()configureCEASettingsForCell
使用此程序來定義 CEA 通訊服務應用程式的環境定義根目錄及虛擬主機。
語法
configureCEASettingsForCell(context_root, virtual_host)- context_root
- 指定 REST 介面的環境定義根目錄。 使用此選項，將不同的環境定義根目錄指派給 REST 介面。 環境定義根目錄與為 REST 介面所定義的 Servlet 對映組合起來就是完整的 URL，使用者就是輸入這個 URL 以提出 REST 要求。 比方說，如果環境定義根目錄是
/gettingstarted，而 Servlet 對映是CommServlet/call，URL 便是http://host:port/gettingstarted/CommServlet/call。 - 虛擬主機
- 指定 REST 介面目前所對映之虛擬主機的名稱。
範例用法
![[Windows]](../images/ngwin.svg)
configureCEASettingsForCell("\commsvc.rest", "default_host")![[Linux]](../images/nglinux.svg)
![[AIX]](../images/ngaix.svg)
![[z/OS]](../images/ngzos.svg)
![[HP-UX]](../images/nghpux.svg)
![[Solaris]](../images/ngsolaris.svg)
configureCEASettingsForCell("/commsvc.rest", "default_host")showCEASettingsForServer
使用此程序來顯示 CEA 通訊服務應用程式的狀態、REST 介面保留時間上限、電話系統存取方法，以及特定伺服器的相關電話系統介面設定。 使用 configureCEASettingsForServer 程序來瞭解每一個設定。
語法
showCEASettingsForServer(node_name, server_name)- node_name
- 指定伺服器所在的節點。
- server_name
- 指定您使用此程序來管理的伺服器名稱。
範例用法
showCEASettingsForServer(localhostNode01,server1)configureCEASettingsForServer
使用此程序來定義 CEA 通訊服務應用程式的狀態、REST 介面保留時間上限、電話系統存取方法，以及特定伺服器的相關電話系統介面設定。
語法
configureCEASettingsForServer(node_name, server_name, enable_CEA, max_request_hold_time,
telephony_access_method, gateway_address, gateway_port, gatewayProtocol,
extract_username_from_request, super_username, third_party_WSDL_provider))- node_name
- 指定伺服器所在的節點。
- server_name
- 指定您正在使用此程序來配置的伺服器名稱。
- 啟用 CEA
- 指定您要啟用 CEA。 有效值為 true 及 false。 預設值為 false。
- max_request_hold_time
- 指定 GET /事件呼叫 REST 介面，以等待新資料或變更資料或狀態的時間（秒），此時間過後即逾時。 預設值為 30。
- telephony_access_method
- 指定您要使用 SIP CTI 閘道或協力廠商 WSDL 提供者來進行電話系統存取。 有效值為 SIP_CTI_GATEWAY 及 THIRD_PARTY_WEB_SERVICE。 預設值是 SIP_CTI_GATEWAY。
- 閘道位址
- 指定您要由 CEA 服務連接之 CTI 閘道的位址或完整網域名稱 FQDM。 預設值是 localhost。
- 閘道埠
- 指定 CEA 服務要連接的 CTI 閘道埠。 預設值為 5060。
- gatewayProtocol
- 指定連接至 CTI、TR/87、閘道時要用的通訊協定。 有效值為 TCP, UDP及 TLS。 預設值是 TCP。
- extract_username_from_request
- 指定您要從 HTTP 要求擷取使用者名稱。 有效值為 true 及 false。 預設值為 false。
啟用此功能時，會嘗試從 HTTP 要求中擷取使用者名稱。 如果無法擷取名稱，就會使用超級使用者名稱。 當開啟新的 TR/87 階段作業到 CTI 閘道時，會使用這個名稱。
避免麻煩: 啟用「從要求擷取使用者名稱」選項之後，會嘗試從 HTTP 要求擷取使用者名稱。 但是，即使是已鑑別的使用者，使用者名稱為空值。 「CEA Rest 服務 Servlet」是未受保護的 URI。 因此，當存取不受保護的 URI 時，您也必須啟用使用可用的鑑別資料選項。 請利用管理主控台，在安全> 廣域安全> Web 和 SIP 安全> 一般設定之下，啟用當存取未受保護的 URI 時，使用可用的鑑別資料選項。 啟用這個選項之後，在要求期間，使用者名稱即可供「CEA Rest 服務 Servlet」使用。 - super_username
- 指定開啟新的 TR/87 階段作業到已配置的 CTI 閘道時使用的名稱。 這需要使用用來代表所有一般使用者建立通話的超級使用者帳戶，來配置 CTI 閘道。 預設值為 ceauser。
- third_party_WSDL_provider
- 指定您要使用協力廠商 Web 服務提供者來進行電話系統存取。 這種方法並不使用 SIP CTI，而是使用協力廠商服務，此服務實作了特定的 Web 服務，利用不同的方法來連接至電話系統基礎架構。
範例用法
configureCEASettingsForServer("localhostNode01", "server1", "false | true", "30",
"SIP_CTI_GATEWAY | THIRD_PARTY_WEB_SERVICE", "localhost", "5060", "TCP | UDP | TLS",
"false | true", "ceauser", '""')showCEASettingsForCluster
使用此程序來顯示 CEA 通訊服務應用程式的狀態、REST 介面保留時間上限、電話系統存取方法，以及特定叢集的相關電話系統介面設定。 使用 configureCEASettingsForCluster 程序來瞭解每一個設定。
語法
showCEASettingsForCluster(cluster_name)- CLUSTER_NAME
- 指定您使用此程序來管理的叢集名稱。
範例用法
showCEASettingsForCluster("cluster1")configureCEASettingsForCluster
使用此程序來定義 CEA 通訊服務應用程式的狀態、REST 介面保留時間上限、電話系統存取方法，以及特定叢集的相關電話系統介面設定。
語法
configureCEASettingsForCluster(cluster_name, enable_CEA, max_request_hold_time,
telephony_access_method, gateway_address, gateway_port, gatewayProtocol,
extract_username_from_request, super_username, third_party_WSDL_provider))- CLUSTER_NAME
- 指定您使用此程序來配置的叢集名稱。
- 啟用 CEA
- 指定您要啟用 CEA。 有效值為 true 及 false。
- max_request_hold_time
- 指定 GET /事件呼叫 REST 介面，以等待新資料或變更資料或狀態的時間（秒），此時間過後即逾時。 預設值為 30。
- telephony_access_method
- 指定您要使用 SIP CTI 閘道來進行電話系統存取。 有效值為 true 及 false。
- 閘道位址
- 指定您要由 CEA 服務連接之 CTI 閘道的位址或完整網域名稱 FQDM。 預設值是 localhost。
- 閘道埠
- 指定 CEA 服務要連接的 CTI 閘道埠。 預設值為 5060。
- gatewayProtocol
- 指定連接至 CTI、TR/87、閘道時要用的通訊協定。 有效值為 TCP, UDP及 TLS。 預設值是 TCP。
- extract_username_from_request
- 指定您要從 HTTP 要求擷取使用者名稱。 當啟用時，系統會嘗試從 HTTP 要求中擷取使用者名稱。 如果無法擷取名稱，就會使用超級使用者名稱。 當開啟新的 TR/87 階段作業到 CTI 閘道時，會使用這個名稱。 有效值為 true 及 false。 預設值為 false。避免麻煩: 啟用「從要求擷取使用者名稱」選項之後，會嘗試從 HTTP 要求擷取使用者名稱。 但是，即使是已鑑別的使用者，使用者名稱為空值。 「CEA Rest 服務 Servlet」是未受保護的 URI。 因此，當存取不受保護的 URI 時，您也必須啟用使用可用的鑑別資料選項。 請利用管理主控台，在安全> 廣域安全> Web 和 SIP 安全> 一般設定之下，啟用當存取未受保護的 URI 時，使用可用的鑑別資料選項。 啟用這個選項之後，在要求期間，使用者名稱即可供「CEA Rest 服務 Servlet」使用。
- super_username
- 指定開啟新的 TR/87 階段作業到已配置的 CTI 閘道時使用的名稱。 這需要使用用來代表所有一般使用者建立通話的超級使用者帳戶，來配置 CTI 閘道。 預設值為 ceauser。
- third_party_WSDL_provider
- 指定您要使用協力廠商 Web 服務提供者來進行電話系統存取。 這種方法並不使用 SIP CTI，而是使用協力廠商服務，此服務實作了特定的 Web 服務，利用不同的方法來連接至電話系統基礎架構。
範例用法
configureCEASettingsForCluster("cluster1", "false | true", "30",
"SIP_CTI_GATEWAY | THIRD_PARTY_WEB_SERVICE", "localhost", "5060", "TCP | UDP | TLS",
"false | true", "ceauser", '""')管理 SIP 應用程式路由器的程序
showAll路由器
使用這個程序來顯示指派給預設 SIP 應用程式路由器的目標，以及部署在每一個目標上之應用程式的啟動順序 (加權) ，以及指派給每一個自訂 SIP 應用程式路由器的目標。
語法
showAllRouters()範例用法
showAllRouters()showDefault路由器
使用這個程序來顯示指派給預設 SIP 應用程式路由器的目標，以及部署在每一個目標上之應用程式的啟動順序 (加權)。
語法
showDefaultRouter()範例用法
showDefaultRouter()showAllCustomRouters
使用此程序來顯示指派給每一個自訂 SIP 應用程式路由器的目標。
語法
showAllCustomRouters()範例用法
showAllCustomRouters()showCustom路由器
使用此程序來顯示指派給特定自訂 SIP 應用程式路由器的目標。
語法
showCustomRouter(router_name)範例用法
showCustomRouter("RouterOne")createRouter
使用此程序來建立新的自訂 SIP 應用程式路由器。
語法
createRouter(router_name, router_provider)- 路由名稱
- 指定代表應用程式路由器的邏輯名稱。
- 路由提供者
- 指定應用程式路由器的提供者名稱。 這個路由器提供者定義在自訂應用程式路由器 Jar 檔中，它必須在應用程式伺服器的類別路徑中。
範例用法
createRouter("RouterOne", "RouterProviderOne")modifyRouter
使用此程序來修改自訂 SIP 應用程式路由器的名稱和說明。
語法
modifyRouter(router_name, new_router_name, new_router_provider)- 路由名稱
- 指定代表應用程式路由器的邏輯名稱。
- 新遞送名稱
- 指定您要用來代表應用程式路由器的新邏輯名稱。
- new_router_provider
- 指定應用程式路由器的新提供者名稱。 這個路由器提供者定義在自訂應用程式路由器 Jar 檔中，它必須在應用程式伺服器的類別路徑中。
範例用法
modifyRouter("RouterOne", "Router1", "RouterProvider1")deleteRouter
使用此程序來刪除自訂 SIP 應用程式路由器。
語法
deleteRouter(router_name)- 路由名稱
- 指定代表應用程式路由器的邏輯名稱。
範例用法
deleteRouter("RouterOne")moveServerToCustom路由器
使用此程序，將伺服器移至自訂 SIP 應用程式路由器。
語法
moveServerToCustomRouter(node_name, server_name, router_name)- node_name
- 指定伺服器所在的節點。
- server_name
- 指定您要移至自訂 SIP 應用程式路由器的伺服器名稱。
- 路由名稱
- 指定代表應用程式路由器的邏輯名稱。
範例用法
moveServerToCustomRouter("AppSrvCEANode01", "server1", "RouterOne")moveServerToDefault路由器
使用此程序，將伺服器移至預設 SIP 應用程式路由器。
語法
moveServerToDefaultRouter(node_name, server_name)- node_name
- 指定伺服器所在的節點。
- server_name
- 指定您要移至預設 SIP 應用程式路由器的伺服器名稱。
範例用法
moveServerToDefaultRouter("AppSrvCEANode01", "server1")moveClusterToCustom路由器
使用此程序，將叢集移至自訂 SIP 應用程式路由器。
語法
moveClusterToCustomRouter(cluster_name, router_name)- CLUSTER_NAME
- 指定您要移至自訂 SIP 應用程式路由器的叢集名稱。
- 路由名稱
- 指定代表應用程式路由器的邏輯名稱。
範例用法
moveClusterToCustomRouter("cluster1", "RouterOne")moveClusterToDefault路由器
使用此程序，將叢集移至預設 SIP 應用程式路由器。
語法
moveClusterToDefaultRouter(cluster_name)- CLUSTER_NAME
- 指定您要移至預設 SIP 應用程式路由器的叢集名稱。
範例用法
moveClusterToDefaultRouter("cluster1")