executeWLST

Execute WLST Commands. You can specify WLST code snippet on Plugin Input. Refer to FlexDeploy - Variables Guide for available variables.

This plugin operation provides the ability for the user to define additional inputs that will be available to the WLST script when executing. In addition, the plugin provides the ability for the user to define any number of outputs from the execution of the script that could be utilized in subsequent steps in the workflow.

Environment/Instance Properties

Property Name

Property Code

Required

Description

Oracle Weblogic Home (WL_HOME)

FDWLS_WEBLOGIC_HOME

Yes

WebLogic Home Directory. (e.g. /u01/oracle/products/fmw/wlserver)

Weblogic Domain Name

FDWLS_DOMAIN_NAME

Yes

WebLogic Domain Name.

Weblogic Admin Listen Address

FDWLS_ADMIN_LISTEN_ADDRESS

Yes

The listener address of the WLS admin server. (e.g. localhost)

Weblogic Admin Listen Port

FDWLS_ADMIN_LISTEN_PORT

Yes

The port of the WLS admin server. (e.g. 7001)

Weblogic Admin SSL Connection

FDWLS_ADMIN_USE_SSL

No

Indicates whether the admin server is using SSL.

Weblogic Admin User

FDWLS_ADMIN_USER

Yes

The user name for the WLS admin server.

Weblogic Admin Password

FDWLS_ADMIN_PASSWORD

Yes

The password for FDWLS_ADMIN_USER.

Weblogic Application Install Directory

FDWLS_BASE_INSTALL_DIRECTORY

No

Base directory to install the WebLogic deployments from.

Files will be copied here on Admin Server endpoint by WebLogic plugin prior to installation.

For example: /oracle/middleware/product/user_projects/applications

Weblogic Admin Server Name

FDWLS_ADMIN_SERVER_NAME

No

WebLogic Admin Server Name. Defaults to AdminServer.

Weblogic Admin Domain Directory

FDWLS_ADMIN_DOMAIN_DIRECTORY

No

WebLogic Domain Directory for AdminServer. Used when the admin server runs from a different domain folder than managed servers

Weblogic Domain Directory

FDWLS_DOMAIN_DIRECTORY

Yes

WebLogic Domain Directory for managed servers.

Weblogic Node Manager Port

FDWLS_NODEMANAGER_PORT

Yes

The port for the WLS Node Manager.

Weblogic Node Manager User

FDWLS_NODEMANAGER_USER

Yes

The user id for the WLS Node Manager.

Weblogic Node Manager Password

FDWLS_NODEMANAGER_PASSWORD

Yes

The password for FDWLS_NODEMANAGER_USER

Weblogic Node Manager Host

FDWLS_NODEMANAGER_HOST

Yes

Host for Node Manager connection.

Weblogic Node Manager Type

FDWLS_NODEMANAGER_TYPE

No

Node Manager Type. (e.g. ssl, plain, SSH, RSH)

Oracle Middleware Home (MW_HOME

FD_ORACLE_MW_HOME

Yes

The oracle middleware home (which has subfolders such as oracle_common, wlsserver_10.3, coherence*, etc.).

Project Properties

Property Name

Property Code

Required

Description





Inputs

Input Name

Input Code

Required

Description

WLST Script Folder

FDWLST_INP_SCRIPT_FOLDER

No

WLST sub-folder for Fusion Middleware. (e.g wlserver, oracle_common, soa, wcportal etc.)

WLST Code Snippet

FDWLST_INP_CODE_SNIPPET

Yes

WLST script commands to execute. Return output using fdSetOutput({OUTPUT2}, {VALUE2}).

Outputs

Output Name

Required

Description




Artifacts

This operation delegates the consume/produce artifacts decision to the workflow developer. Check Consumes Artifacts on workflow editor if this operation needs artifact files. Check Produces Artifacts on workflow editor if this operation creates artifact files. There is a specific folder for artifacts which is available as variable FD_ARTIFACTS_DIR.

Endpoint Selection

This operation will select all available endpoints associated to the environment instance which have a resource type of WLS Admin Server. Since the admin server only runs on one server, it is expected that for a given domain, there will only be one endpoint with a resource type set to WLS Admin Server.

Endpoint Execution

This operation will execute on the Admin Server endpoint selected using the WLS Admin Server resource type.

Special Considerations

WLST code can utilize additional functions provided by this plugin. Function names are self-explanatory. If you are using wlserver for WLST Script Folder, then only you can use wfcontext variable, it is always better to use fdGetEnv function to get variable values.

Get environment variable value for supplied key. Jython module os.getenv(str) method does not appear to be working at times. This API uses java.lang.System class to get value for environment variable.

Get Environment Variable
def fdGetEnv(environmentKey):

For example, get project name

Get Environment Variable (Example)
fdGetEnv('FD_PROJECT_NAME')

Create log message using method name and message.

Log
 def fdLog(methodName, message):

Set output using provided name and value.

Set Output (return value)
def fdSetOutput(name, value):

Disconnect from Admin Server.

Disconnect from AdminServer
def fdDisconnect():

Connect to Admin Server represented by current instance.

Connect to AdminServer of current instance
def fdConnectToCurrentInstance():

Connect to Admin Server represented by specified instance code.

Connect to AdminServer of specific instance
def fdConnectToInstance(instanceCode):