Back to Top

ActivateBulkWorkflowTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.ActivateBulkWorkflowTask
Category Oracle Siebel 8

Activate Bulk Workflows Task

Description

This task will create a Siebel Java Data bean to connect to the Siebel Server. The connection details are taken from the Siebel environment settings, these settings can be overridden by the settings in this task. Once a connection is established the flow search spec is then used to retrieve a list of the actual workflow names. The list of workflow names are then processed in chunks, based on the 'chunkSize' property. The "Workflow Admin Service" Siebel Service is retrieved to load search for the workflows using the search spec. The service will then invoke the "Activate" method on the service and the number of workflows activated will be logged out into the log file. This task can activate workflows concurrently on multiple servers using a comma separated list of targetSeverNames and a comma separated list of flowSearchSpecs.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
chunkSize java.lang.Integer 0 true The list of workflow names processed in chunks of this size, before the Java data bean is logged out and logged back in.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
flowSearchSpecs java.lang.String [Name] Like "PUB*",[Name] Like "ABC*" true The search specification used by the Workflow Admin Service to search for workflows to activate. If run concurrently use a comma separated list.
sadminPassword java.lang.String SADMIN true Password for Siebel Administration User (default username: SADMIN).
sadminUserName java.lang.String SADMIN true Name of the Siebel admin user to connect with (default username: SADMIN).
siebelAomName java.lang.String PSCcObjMgr_enu true Name of the Siebel Application Object Manager Component.
siebelEnterpriseServerName java.lang.String En_SblSIT true Name of the Siebel Enterprise Server. Should reflect the Environment Name (Ex: Dev or QA etc...)
siebelPropertiesPath java.lang.String   true The package relative path to the siebel.properties file which is used by the Java Data Bean for the connection properties e.g. siebel.connection.string, siebel.user.name, siebel.user.password, siebel.user.language, siebel.conmgr.txtimeout, siebel.conmgr.poolsize, siebel.conmgr.sesstimeout and siebel.conmgr.retry. If not set the Siebel environment settings are used.
siebelServerConnectionLanguage java.lang.String enu true Siebel Server Connection Language.
siebelServerConnectionPort java.lang.Integer 2321 true Connection port number of the Siebel Server.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
targetServerNames java.lang.String server1,server2 true Comma separated list of target servers.


Back to Top

ActivateFINSValidationRulesTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.ActivateFINSValidationRulesTask
Category Oracle Siebel 8

Activate FINS Validation Ruleset Task

Description

This task will create a Siebel Java Data bean to connect to the Siebel Server. The connection details are taken from the Siebel environment settings, these settings can be overridden by the settings in this task. This task will activate FINS Validation Rule Sets that have a status of "In Progress" and match one of the comma separated name search specifications.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
nameSearchSpecs java.lang.String   false A comma separated list of name search specifications for the FINS Validation Rule Sets to activate.
sadminPassword java.lang.String SADMIN true Password for Siebel Administration User (default username: SADMIN).
sadminUserName java.lang.String SADMIN true Name of the Siebel admin user to connect with (default username: SADMIN).
siebelAomName java.lang.String PSCcObjMgr_enu true Name of the Siebel Application Object Manager Component.
siebelEnterpriseServerName java.lang.String En_SblSIT true Name of the Siebel Enterprise Server. Should reflect the Environment Name (Ex: Dev or QA etc...)
siebelPropertiesPath java.lang.String   true The package relative path to the siebel.properties file which is used by the Java Data Bean for the connection properties e.g. siebel.connection.string, siebel.user.name, siebel.user.password, siebel.user.language, siebel.conmgr.txtimeout, siebel.conmgr.poolsize, siebel.conmgr.sesstimeout and siebel.conmgr.retry. If not set the Siebel environment settings are used.
siebelServerConnectionLanguage java.lang.String enu true Siebel Server Connection Language.
siebelServerConnectionPort java.lang.Integer 2321 true Connection port number of the Siebel Server.
siebelServerNames java.lang.String localhost true Comma separated list of Siebel Server hostnames or IP addresses.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.


Back to Top

AssignmentRulesReleaseTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.AssignmentRulesReleaseTask
Category Oracle Siebel 8

Assignment Rules Release Task

Description

This task will create a Siebel Java Data bean to connect to the Siebel Server. The connection details are taken from the Siebel environment settings, these settings can be overridden by the settings in this task. Once a connection is established the "Assignment" Siebel Business Object. Then a 'Assignment Group' Business component is retrieved to assign based on the name search specification. The component will invoke the "Release" method.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean false false This task will not fail the deployment on error if set to false.
nameSearchSpec java.lang.String   false A search specification for the field 'Name' in the Assignment Rules Release Business Component.
sadminPassword java.lang.String SADMIN true Password for Siebel Administration User (default username: SADMIN).
sadminUserName java.lang.String SADMIN true Name of the Siebel admin user to connect with (default username: SADMIN).
siebelAomName java.lang.String PSCcObjMgr_enu true Name of the Siebel Application Object Manager Component.
siebelEnterpriseServerName java.lang.String En_SblSIT true Name of the Siebel Enterprise Server. Should reflect the Environment Name (Ex: Dev or QA etc...)
siebelPropertiesPath java.lang.String   true The package relative path to the siebel.properties file which is used by the Java Data Bean for the connection properties e.g. siebel.connection.string, siebel.user.name, siebel.user.password, siebel.user.language, siebel.conmgr.txtimeout, siebel.conmgr.poolsize, siebel.conmgr.sesstimeout and siebel.conmgr.retry. If not set the Siebel environment settings are used.
siebelServerConnectionLanguage java.lang.String enu true Siebel Server Connection Language.
siebelServerConnectionPort java.lang.Integer 2321 true Connection port number of the Siebel Server.
siebelServerNames java.lang.String localhost true Comma separated list of Siebel Server hostnames or IP addresses.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.


Back to Top

ChangeNameAndActiveRepositoryTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.ChangeNameAndActiveRepositoryTask
Category Oracle Siebel 8

Change Name and Activate Repository Task

Description

This task will create a Siebel Java Data bean to connect to the Siebel Server. The connection details are taken from the Siebel environment settings, these settings can be overridden by the settings in this task. Once a connection is established the "Repository Repository" Siebel Business Object is retrieved to load the "Repository Repository" Siebel Businesss Component. The business component data is then searched for Repository with the name "Siebel Repository". If this is found it is deactivated and renamed to "Siebel_Repository_DATETIMESTAMP" using the current data and time stamp. The imported repository name is then found and activated and renamed to "Siebel Repository".

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
backupRepositoryName java.lang.String   false The named used to rename the existing active repository.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
importRepositoryComments java.lang.String Renaming repository using RapidDeploy. false Comments used as the repository comments.
importRepositoryName java.lang.String repository1 false The named used to import the repository.
sadminPassword java.lang.String SADMIN true Password for Siebel Administration User (default username: SADMIN).
sadminUserName java.lang.String SADMIN true Name of the Siebel admin user to connect with (default username: SADMIN).
siebelAomName java.lang.String PSCcObjMgr_enu true Name of the Siebel Application Object Manager Component.
siebelEnterpriseServerName java.lang.String En_SblSIT true Name of the Siebel Enterprise Server. Should reflect the Environment Name (Ex: Dev or QA etc...)
siebelPropertiesPath java.lang.String   true The package relative path to the siebel.properties file which is used by the Java Data Bean for the connection properties e.g. siebel.connection.string, siebel.user.name, siebel.user.password, siebel.user.language, siebel.conmgr.txtimeout, siebel.conmgr.poolsize, siebel.conmgr.sesstimeout and siebel.conmgr.retry. If not set the Siebel environment settings are used.
siebelServerConnectionLanguage java.lang.String enu true Siebel Server Connection Language.
siebelServerConnectionPort java.lang.Integer 2321 true Connection port number of the Siebel Server.
siebelServerNames java.lang.String localhost true Comma separated list of Siebel Server hostnames or IP addresses.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.


Back to Top

DDLSyncTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.DDLSyncTask
Category Oracle Siebel 8

DDL Synronise Repository Task

Description

This task will encrypt the Siebel passwords using the encryptstring utility and then generates a response file using the ssincfgw utility to create a master ddlsync file. This master ddlsync file is then used to synchronise the DDL using the srvrupgwiz utility.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
dataTablespaceName java.lang.String SIEB_DATA true Tablespace Name for Holding Tables/Data.
errorFilePath java.lang.String   true Project relative path to a file containing a list of error messages (on each line of the file) to look for in the process output, if one of the error messages is found then a task exception is thrown.
errorMessage java.lang.String   true Error message to look for in the process output, if the error message is found then then a task exception is thrown.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
indexTablespaceName java.lang.String SIEB_INDEX true Tablespace Name for Holding Indexes.
processAnswer java.lang.String   true This setting is used in conjunction with the resource named [processQuestion]. If the process asks the question text and then waits for a user input, this [processAnswer] resource is used as the input.
processQuestion java.lang.String   true This setting is used in conjunction with the resource named [processAnswer]. If the process asks this question text and then waits for a user input, the [processAnswer] resource is used as the input.
relativeDdlSyncXmlFilePath java.lang.String siebel/scripts/ddlsync.xml false Project relative path to the ddlsync.xml file.
sadminPassword java.lang.String SADMIN true Password for Siebel Administration User (default username: SADMIN).
sadminUserName java.lang.String SADMIN true Name of the Siebel admin user to connect with (default username: SADMIN).
siebelDbPassword java.lang.String SIEBEL true Password for User 'SIEBEL'. User 'SIEBEL' is used as Table Owner.
siebelDbSrvrPath java.lang.String /siebel/dbsrvr true The path to Siebel DB Server.
siebelDbUserName java.lang.String SIEBEL true Name of the Siebel DB Owner Username.
siebelEnterpriseServerName java.lang.String En_SblSIT true Name of the Siebel Enterprise Server. Should reflect the Environment Name (Ex: Dev or QA etc...)
siebelServerConnectionLanguage java.lang.String enu true Siebel Server Connection Language.
siebelSrvrPath java.lang.String /siebel/siebsrvr true The path to the Siebel Server.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
successFilePath java.lang.String   true Project relative path to a file containing a list of success messages (on each line of the file) to look for in the process output, if one of the success strings is found then a task exception is not thrown.
successMessage java.lang.String   true Success message to look for in the process output, if the success message is not found then then a task exception is thrown.


Back to Top

DeleteBulkWorkflowTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.DeleteBulkWorkflowTask
Category Oracle Siebel 8

Delete Bulk Workflows Task

Description

This task will create a Siebel Java Data bean to connect to the Siebel Server. The connection details are taken from the Siebel environment settings, these settings can be overridden by the settings in this task. Once a connection is established the flow search spec is then used to retrieve a list of the actual workflow names. The list of workflow names are then processed in chunks, based on the 'chunkSize' property. This task will create a Siebel Java Data bean to connect to the Siebel Server. The connection details are taken from the Siebel environment settings, these settings can be overridden by the settings in this task. The "Workflow Admin Service" Siebel Service is retrieved to load search for the workflows using the search spec. The service will then invoke the "DeleteDeploy" method on the service and the number of workflows deactivated will be logged out into the log file. This task can activate workflows concurrently on multiple servers using a comma separated list of targetSeverNames and a comma separated list of flowSearchSpecs.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
chunkSize java.lang.Integer 0 true The list of workflow names processed in chunks of this size, before the Java data bean is logged out and logged back in.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
flowSearchSpecs java.lang.String [Name] Like "PUB*",[Name] Like "ABC*" true The search specification used by the Workflow Admin Service to search for workflows to delete. If run concurrently use a comma separated list.
sadminPassword java.lang.String SADMIN true Password for Siebel Administration User (default username: SADMIN).
sadminUserName java.lang.String SADMIN true Name of the Siebel admin user to connect with (default username: SADMIN).
siebelAomName java.lang.String PSCcObjMgr_enu true Name of the Siebel Application Object Manager Component.
siebelEnterpriseServerName java.lang.String En_SblSIT true Name of the Siebel Enterprise Server. Should reflect the Environment Name (Ex: Dev or QA etc...)
siebelPropertiesPath java.lang.String   true The package relative path to the siebel.properties file which is used by the Java Data Bean for the connection properties e.g. siebel.connection.string, siebel.user.name, siebel.user.password, siebel.user.language, siebel.conmgr.txtimeout, siebel.conmgr.poolsize, siebel.conmgr.sesstimeout and siebel.conmgr.retry. If not set the Siebel environment settings are used.
siebelServerConnectionLanguage java.lang.String enu true Siebel Server Connection Language.
siebelServerConnectionPort java.lang.Integer 2321 true Connection port number of the Siebel Server.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
targetServerNames java.lang.String server1,server2 true Comma separated list of target servers.


Back to Top

DeleteRepositoryEntryTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.DeleteRepositoryEntryTask
Category Oracle Siebel 8

Delete Repository Entry Task

Description

This task will either use the 'repositoryNameSearchSpec' resource to find a resource to delete or if that resource is not set it will connect to the database directly and will run the following SQL statement to find a list of names to delete.

SELECT repository_name FROM (SELECT ROW_NUMBER() OVER (ORDER BY created desc) row_num, sr.name as repository_name, sr.created as created FROM siebel.s_repository sr) WHERE repository_name != 'Seibel Respository' and row_num > 'noOfRepositoriesToRetain';

This task will create a Siebel Java Data bean to connect to the Siebel Server. The connection details are taken from the Siebel environment settings, these settings can be overridden by the settings in this task. Once a connection is established the "Repository Repository" Siebel Business Object is retrieved to load the "Repository Repository" Siebel Businesss Component. The business component data is then searched for Repository with the named 'repositoryNameSearchSpec' resource or the results of the SQL statement. If records are found, they are deleted from the repository. If the repository found has the name "Siebel Repository", that record is ignored and not deleted. If a record is found and deleted, then directory /log/imprep is moved to /log/imprep_.
This task is useful if the ImportRepository task fails and needs to be re-run as it leaves the repository record in an invalid state.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
dbDriverClassName java.lang.String oracle.jdbc.pool.OracleConnectionPoolDataSource true Oracle driver class name.
dbPassword java.lang.String dbPassword true DB user password, if not set then uses the Siebel Environment DB password.
dbURL java.lang.String jdbc:oracle:thin:@localhost:1521:xe true The JDBC connection URL for this oracle DB, either a standalone or RAC URL.
dbUserName java.lang.String dbUserName true DB user name, if not set then uses the Siebel Environment DB username.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
noOfRepositoriesToRetain java.lang.Integer 2 true The number of repositories to retain in the database.
repositoryNameSearchSpec java.lang.String   true The repository name used to search the repository for records to delete. For example: [NAME] Like '*REP'
sadminPassword java.lang.String SADMIN true Password for Siebel Administration User (default username: SADMIN).
sadminUserName java.lang.String SADMIN true Name of the Siebel admin user to connect with (default username: SADMIN).
siebelAomName java.lang.String PSCcObjMgr_enu true Name of the Siebel Application Object Manager Component.
siebelEnterpriseServerName java.lang.String En_SblSIT true Name of the Siebel Enterprise Server. Should reflect the Environment Name (Ex: Dev or QA etc...)
siebelPropertiesPath java.lang.String   true The package relative path to the siebel.properties file which is used by the Java Data Bean for the connection properties e.g. siebel.connection.string, siebel.user.name, siebel.user.password, siebel.user.language, siebel.conmgr.txtimeout, siebel.conmgr.poolsize, siebel.conmgr.sesstimeout and siebel.conmgr.retry. If not set the Siebel environment settings are used.
siebelServerConnectionLanguage java.lang.String enu true Siebel Server Connection Language.
siebelServerConnectionPort java.lang.Integer 2321 true Connection port number of the Siebel Server.
siebelServerNames java.lang.String localhost true Comma separated list of Siebel Server hostnames or IP addresses.
siebelSrvrPath java.lang.String /siebel/siebsrvr true The path to the Siebel Server.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.


Back to Top

ExecuteGatewayServerCommandTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.ExecuteGatewayServerCommandTask
Category Oracle Siebel 8

Execute Siebel Gateway Name Server Command Task

Description

This task will execute a Siebel Gateway Name Server command e.g. start_ns or srvredit.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
errorFilePath java.lang.String   true Project relative path to a file containing a list of error messages (on each line of the file) to look for in the process output, if one of the error messages is found then a task exception is thrown.
errorMessage java.lang.String   true Error message to look for in the process output, if the error message is found then then a task exception is thrown.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
gatewayServerCmd java.lang.String   false A Siebel Gateway Server command to execute e.g. start_ns, stop_ns.
siebelGtwySrvrPath java.lang.String /siebel/gtwysrvr false The path to the Siebel Gateway Server.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
successFilePath java.lang.String   true Project relative path to a file containing a list of success messages (on each line of the file) to look for in the process output, if one of the success strings is found then a task exception is not thrown.
successMessage java.lang.String   true Success message to look for in the process output, if the success message is not found then then a task exception is thrown.


Back to Top

ExecuteSiebelServerCommandTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.ExecuteSiebelServerCommandTask
Category Oracle Siebel 8

Execute Siebel Server Command Task

Description

This task will execute a Siebel Server command e.g. start_server all or cfgedit.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
errorFilePath java.lang.String   true Project relative path to a file containing a list of error messages (on each line of the file) to look for in the process output, if one of the error messages is found then a task exception is thrown.
errorMessage java.lang.String   true Error message to look for in the process output, if the error message is found then then a task exception is thrown.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
siebelServerCmd java.lang.String   false A Siebel Server command to execute e.g. start_server, stop_server.
siebelSrvrPath java.lang.String /siebel/siebsrvr false The path to the Siebel Server.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
successFilePath java.lang.String   true Project relative path to a file containing a list of success messages (on each line of the file) to look for in the process output, if one of the success strings is found then a task exception is not thrown.
successMessage java.lang.String   true Success message to look for in the process output, if the success message is not found then then a task exception is thrown.


Back to Top

ExecuteSiebelServerGroupCommandTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.ExecuteSiebelServerGroupCommandTask
Category Oracle Siebel 8

Concurrently Execute Siebel Server Command Task

Description

This task will concurrently execute a Siebel Server command on a group of servers defined in the environment.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
errorFilePath java.lang.String   true Project relative path to a file containing a list of error messages (on each line of the file) to look for in the process output, if one of the error messages is found then a task exception is thrown.
errorMessage java.lang.String   true Error message to look for in the process output, if the error message is found then then a task exception is thrown.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
siebelServerCmd java.lang.String   false A Siebel Server command to execute e.g. start_server all, stop_server all.
siebelSrvrPath java.lang.String /siebel/siebsrvr false The path to the Siebel Server.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sshIdentityFile java.lang.String /path/to/identity/file true Local Identity file.
successFilePath java.lang.String   true Project relative path to a file containing a list of success messages (on each line of the file) to look for in the process output, if one of the success strings is found then a task exception is not thrown.
successMessage java.lang.String   true Success message to look for in the process output, if the success message is not found then then a task exception is thrown.
targetServerNames java.lang.String server1,server2 true Comma separated list of target servers.
targetServerSshPassphrase java.lang.String   true Target SSH passphrase (if required).
targetServerSshPassword java.lang.String   true Target SSH Password (if required).
targetServerSshPort java.lang.String 22 false SSH Port on the target server.
targetServerSshTimeout java.lang.String 1200000 false Timeout on the target server(s) in milliseconds.
targetServerSshUser java.lang.String sshUser false Target SSH user.


Back to Top

ExecuteSiebelServerSrvrMgrCommandTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.ExecuteSiebelServerSrvrMgrCommandTask
Category Oracle Siebel 8

Execute Siebel Server Manager Command Task

Description

This task will execute a Siebel Server srvrmgr command e.g. list servers. You can optionally specify an error string to find in the output, if the error string if found then a task exception is thrown.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
errorFilePath java.lang.String   true Project relative path to a file containing a list of error messages (on each line of the file) to look for in the process output, if one of the error messages is found then a task exception is thrown.
errorMessage java.lang.String   true Error message to look for in the process output, if the error message is found then then a task exception is thrown.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
gatewayHostname java.lang.String localhost true The host DNS or IP address of the Siebel Gateway Server.
sadminPassword java.lang.String SADMIN true Password for Siebel Administration User (default username: SADMIN).
sadminUserName java.lang.String SADMIN true Name of the Siebel admin user to connect with (default username: SADMIN).
siebelEnterpriseServerName java.lang.String En_SblSIT true Name of the Siebel Enterprise Server. Should reflect the Environment Name (Ex: Dev or QA etc...)
siebelSrvrPath java.lang.String /siebel/siebsrvr false The path to the Siebel Server.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
srvrmgrCmd java.lang.String list servers false A Siebel Server srvrmgr command to execute, used as the /c switch of the command e.g. list servers.
successFilePath java.lang.String   true Project relative path to a file containing a list of success messages (on each line of the file) to look for in the process output, if one of the success strings is found then a task exception is not thrown.
successMessage java.lang.String   true Success message to look for in the process output, if the success message is not found then then a task exception is thrown.


Back to Top

ExecuteSiebelServerSrvrMgrScriptTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.ExecuteSiebelServerSrvrMgrScriptTask
Category Oracle Siebel 8

Execute Siebel Server Manager Script Task

Description

This task will execute a Siebel Server srvrmgr script. You can optionally specify an error string to find in the output, if the error string if found then a task exception is thrown.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
errorFilePath java.lang.String   true Project relative path to a file containing a list of error messages (on each line of the file) to look for in the process output, if one of the error messages is found then a task exception is thrown.
errorMessage java.lang.String   true Error message to look for in the process output, if the error message is found then then a task exception is thrown.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
gatewayHostname java.lang.String localhost true The host DNS or IP address of the Siebel Gateway Server.
relativeSrvrmgrScript java.lang.String siebel/scripts/srvmgrScript.txt false A Siebel Server srvrmgr script, used as the /i switch of the command.
sadminPassword java.lang.String SADMIN true Password for Siebel Administration User (default username: SADMIN).
sadminUserName java.lang.String SADMIN true Name of the Siebel admin user to connect with (default username: SADMIN).
siebelEnterpriseServerName java.lang.String En_SblSIT true Name of the Siebel Enterprise Server. Should reflect the Environment Name (Ex: Dev or QA etc...)
siebelSrvrPath java.lang.String /siebel/siebsrvr false The path to the Siebel Server.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
successFilePath java.lang.String   true Project relative path to a file containing a list of success messages (on each line of the file) to look for in the process output, if one of the success strings is found then a task exception is not thrown.
successMessage java.lang.String   true Success message to look for in the process output, if the success message is not found then then a task exception is thrown.


Back to Top

ExecuteSiebelWebServerCommandTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.ExecuteSiebelWebServerCommandTask
Category Oracle Siebel 8

Execute Siebel Web Server Command Task

Description

This task will execute a Siebel Web Server command.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
errorFilePath java.lang.String   true Project relative path to a file containing a list of error messages (on each line of the file) to look for in the process output, if one of the error messages is found then a task exception is thrown.
errorMessage java.lang.String   true Error message to look for in the process output, if the error message is found then then a task exception is thrown.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
siebelWebServerCmd java.lang.String   false A Siebel Web Server command to execute e.g. startapa, stopapa.
siebelWebsrvrPath java.lang.String /siebel/sweapp/HTTPServer false The path to the Siebel Web Server.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
successFilePath java.lang.String   true Project relative path to a file containing a list of success messages (on each line of the file) to look for in the process output, if one of the success strings is found then a task exception is not thrown.
successMessage java.lang.String   true Success message to look for in the process output, if the success message is not found then then a task exception is thrown.


Back to Top

ExecuteSiebelWebServerExtCommandTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.ExecuteSiebelWebServerExtCommandTask
Category Oracle Siebel 8

Execute Siebel Web Server Extension Command Task

Description

This task will execute a Siebel Web Server Extension command.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
errorFilePath java.lang.String   true Project relative path to a file containing a list of error messages (on each line of the file) to look for in the process output, if one of the error messages is found then a task exception is thrown.
errorMessage java.lang.String   true Error message to look for in the process output, if the error message is found then then a task exception is thrown.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
siebelWebServerExtCmd java.lang.String   false A Siebel Server Web Extenstion command to execute e.g. ssincfgw.
siebelWebsrvrExtPath java.lang.String /siebel/sweapp false The path to the Siebel Web Server Extensions.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
successFilePath java.lang.String   true Project relative path to a file containing a list of success messages (on each line of the file) to look for in the process output, if one of the success strings is found then a task exception is not thrown.
successMessage java.lang.String   true Success message to look for in the process output, if the success message is not found then then a task exception is thrown.


Back to Top

ExecuteSiebelWebServerGroupCommandTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.ExecuteSiebelWebServerGroupCommandTask
Category Oracle Siebel 8

Concurrently Execute Siebel Web Server Command Task

Description

This task will concurrently execute a Siebel Web Server command on a group of servers defined in the environment.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
errorFilePath java.lang.String   true Project relative path to a file containing a list of error messages (on each line of the file) to look for in the process output, if one of the error messages is found then a task exception is thrown.
errorMessage java.lang.String   true Error message to look for in the process output, if the error message is found then then a task exception is thrown.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
siebelWebServerCmd java.lang.String   false A Siebel Web Server command to execute e.g. startapa, stopapa.
siebelWebsrvrPath java.lang.String /siebel/sweapp/HTTPServer false The path to the Siebel Web Server.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sshIdentityFile java.lang.String /path/to/identity/file true Local Identity file.
successFilePath java.lang.String   true Project relative path to a file containing a list of success messages (on each line of the file) to look for in the process output, if one of the success strings is found then a task exception is not thrown.
successMessage java.lang.String   true Success message to look for in the process output, if the success message is not found then then a task exception is thrown.
targetServerNames java.lang.String server1,server2 true Comma separated list of target servers.
targetServerSshPassphrase java.lang.String   true Target SSH passphrase (if required).
targetServerSshPassword java.lang.String   true Target SSH Password (if required).
targetServerSshPort java.lang.String 22 false SSH Port on the target server.
targetServerSshTimeout java.lang.String 1200000 false Timeout on the target server(s) in milliseconds.
targetServerSshUser java.lang.String sshUser false Target SSH user.


Back to Top

ExecuteSQLPlusScriptTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.ExecuteSQLPlusScriptTask
Category Oracle Siebel 8

DB Execute SQL Script Task

Description

This task will use SQLPlus to execute an SQL script against the DB defined in the Siebel Environment.
Example URL: jdbc:oracle:thin:@host1:1521:service_name
Example RAC URL: jdbc:oracle:thin:@(DESCRIPTION=(LOAD_BALANCE=on)(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=host1)(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=host2)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=service_name)))

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
dbDriverClassName java.lang.String oracle.jdbc.pool.OracleConnectionPoolDataSource true Oracle driver class name.
dbPassword java.lang.String dbPassword true DB user password, if not set then uses the Siebel Environment DB password.
dbURL java.lang.String jdbc:oracle:thin:@localhost:1521:xe true The JDBC connection URL for this oracle DB, either a standalone or RAC URL.
dbUserName java.lang.String dbUserName true DB user name, if not set then uses the Siebel Environment DB username.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
relativeSqlScriptFilePath java.lang.String siebel/scripts/temp.sql false Project relative path to the SQL file to execute in SQLPlus.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.


Back to Top

GenerateBrowserScriptsCommandTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.GenBScriptCommandTask
Category Oracle Siebel 8

Generate Browser Scripts Command Task

Description

This task will run the genbscript to generate the Web javascript files. It will then concurrently copy the generated files onto all the Siebel Servers defined in the Siebel Environment.
Note: this task will not copy the generated browser scripts onto the host the files were generated on, if that host is in the targetServerNames list it will be ignored from the secure copy.
It will also copy the generated files onto all the Siebel Web Extention Servers defined in the Siebel Environment.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
configFile java.lang.String /siebel/siebsrvr/bin/enu/publicsector.cfg true Path of the configuration file, used as the parameter in the genbscript.
destinationDir java.lang.String /siebel/siebsrvr/webmaster true Path of the destination directory, used as the parameter in the genbscript.
destinationWebDir java.lang.String /siebel/sweapp/public/enu true Path of the destination web server directory, used to copy the generated scripts.
errorFilePath java.lang.String   true Project relative path to a file containing a list of error messages (on each line of the file) to look for in the process output, if one of the error messages is found then a task exception is thrown.
errorMessage java.lang.String   true Error message to look for in the process output, if the error message is found then then a task exception is thrown.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
language java.lang.String ENU true Language used as the parameter in the genbscript.
siebelServerConnectionLanguage java.lang.String enu true Siebel Server Connection Language.
siebelSrvrPath java.lang.String /siebel/siebsrvr false The path to the Siebel Server.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sshIdentityFile java.lang.String /path/to/identity/file true Local Identity file.
successFilePath java.lang.String   true Project relative path to a file containing a list of success messages (on each line of the file) to look for in the process output, if one of the success strings is found then a task exception is not thrown.
successMessage java.lang.String   true Success message to look for in the process output, if the success message is not found then then a task exception is thrown.
targetServerNames java.lang.String server1,server2 true Comma separated list of target servers.
targetServerSshPassphrase java.lang.String   true Target SSH passphrase (if required).
targetServerSshPassword java.lang.String   true Target SSH Password (if required).
targetServerSshPort java.lang.String 22 false SSH Port on the target server.
targetServerSshTimeout java.lang.String 1200000 false Timeout on the target server(s) in milliseconds.
targetServerSshUser java.lang.String sshUser false Target SSH user.


Back to Top

ImportRepositoryTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.ImportRepositoryTask
Category Oracle Siebel 8

Import Repository Task

Description

This task will encrypt the Siebel passwords using the encryptstring utility and then generates a response file using the ssincfgw utility to create a master imprep file. This master imprep file is then used to import the Siebel repository using the srvrupgwiz utility.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
customRepositoryName java.lang.String repository1 false The named used to import the repository.
errorFilePath java.lang.String   true Project relative path to a file containing a list of error messages (on each line of the file) to look for in the process output, if one of the error messages is found then a task exception is thrown.
errorMessage java.lang.String   true Error message to look for in the process output, if the error message is found then then a task exception is thrown.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
processAnswer java.lang.String   true This setting is used in conjunction with the resource named [processQuestion]. If the process asks the question text and then waits for a user input, this [processAnswer] resource is used as the input.
processQuestion java.lang.String   true This setting is used in conjunction with the resource named [processAnswer]. If the process asks this question text and then waits for a user input, the [processAnswer] resource is used as the input.
relativeCustomRepositoryPath java.lang.String siebel/repositories/repository1.dat false Project relative path to the siebel repository dat file. Used as the ImprepFileName value in the siebelrepimp.xml file
relativeSiebelRepImpFilePath java.lang.String siebel/scripts/siebelrepimp.xml false Project relative path to the siebelrepimp.xml file.
sadminPassword java.lang.String SADMIN true Password for Siebel Administration User (default username: SADMIN).
sadminUserName java.lang.String SADMIN true Name of the Siebel admin user to connect with (default username: SADMIN).
siebelDbPassword java.lang.String SIEBEL true Password for User 'SIEBEL'. User 'SIEBEL' is used as Table Owner.
siebelDbSrvrPath java.lang.String /siebel/dbsrvr true The path to Siebel DB Server.
siebelDbUserName java.lang.String SIEBEL true Name of the Siebel DB Owner Username.
siebelEnterpriseServerName java.lang.String En_SblSIT true Name of the Siebel Enterprise Server. Should reflect the Environment Name (Ex: Dev or QA etc...)
siebelServerConnectionLanguage java.lang.String enu true Siebel Server Connection Language.
siebelSrvrPath java.lang.String /siebel/siebsrvr true The path to the Siebel Server.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
successFilePath java.lang.String   true Project relative path to a file containing a list of success messages (on each line of the file) to look for in the process output, if one of the success strings is found then a task exception is not thrown.
successMessage java.lang.String   true Success message to look for in the process output, if the success message is not found then then a task exception is thrown.


Back to Top

IPAddressChangeTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.IPAddressChangeTask
Category Oracle Siebel 8

IP Address Change Task

Description

This task will create a Siebel Java Data bean to connect to the Siebel Server. The connection details are taken from the Siebel environment settings, these settings can be overridden by the settings in this task. This task will load the Siebel business object "Web Service" and its Siebel business component "Port". It will then search for a Port by the [portName] resource value. If a Web Service Port is found, then its address will be updated with the [newPortAddress] resource value.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
newPortAddress java.lang.String   false A new Web Service Port address.
portName java.lang.String   false A web service port name, which is used as the search specification to find the for the Web Service Port in the business component to update.
sadminPassword java.lang.String SADMIN true Password for Siebel Administration User (default username: SADMIN).
sadminUserName java.lang.String SADMIN true Name of the Siebel admin user to connect with (default username: SADMIN).
siebelAomName java.lang.String PSCcObjMgr_enu true Name of the Siebel Application Object Manager Component.
siebelEnterpriseServerName java.lang.String En_SblSIT true Name of the Siebel Enterprise Server. Should reflect the Environment Name (Ex: Dev or QA etc...)
siebelPropertiesPath java.lang.String   true The package relative path to the siebel.properties file which is used by the Java Data Bean for the connection properties e.g. siebel.connection.string, siebel.user.name, siebel.user.password, siebel.user.language, siebel.conmgr.txtimeout, siebel.conmgr.poolsize, siebel.conmgr.sesstimeout and siebel.conmgr.retry. If not set the Siebel environment settings are used.
siebelServerConnectionLanguage java.lang.String enu true Siebel Server Connection Language.
siebelServerConnectionPort java.lang.Integer 2321 true Connection port number of the Siebel Server.
siebelServerNames java.lang.String localhost true Comma separated list of Siebel Server hostnames or IP addresses.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.


Back to Top

StartGatewayServerTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.StartGatewayServerTask
Category Oracle Siebel 8

Start Siebel Gateway Name Server Task

Description

This task is like the task ExecuteGatewayServerCommandTask except the command is fixed to: start_ns. It will execute a start_ns command on the Siebel Gateway Name Server.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
errorFilePath java.lang.String   true Project relative path to a file containing a list of error messages (on each line of the file) to look for in the process output, if one of the error messages is found then a task exception is thrown.
errorMessage java.lang.String   true Error message to look for in the process output, if the error message is found then then a task exception is thrown.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
siebelGtwySrvrPath java.lang.String /siebel/gtwysrvr false The path to the Siebel Gateway Server.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
successFilePath java.lang.String   true Project relative path to a file containing a list of success messages (on each line of the file) to look for in the process output, if one of the success strings is found then a task exception is not thrown.
successMessage java.lang.String   true Success message to look for in the process output, if the success message is not found then then a task exception is thrown.


Back to Top

StartSiebelServersTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.StartSiebelServersTask
Category Oracle Siebel 8

Start Siebel Servers Task

Description

This task is like the task ExecuteSiebelServerGroupCommandTask, except the command is fixed to "start_server all". This task will concurrently execute a "start_server all" command on all Siebel Servers defined in the Siebel Environment.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
errorFilePath java.lang.String   true Project relative path to a file containing a list of error messages (on each line of the file) to look for in the process output, if one of the error messages is found then a task exception is thrown.
errorMessage java.lang.String   true Error message to look for in the process output, if the error message is found then then a task exception is thrown.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
siebelSrvrPath java.lang.String /siebel/siebsrvr false The path to the Siebel Server.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sshIdentityFile java.lang.String /path/to/identity/file true Local Identity file.
successFilePath java.lang.String   true Project relative path to a file containing a list of success messages (on each line of the file) to look for in the process output, if one of the success strings is found then a task exception is not thrown.
successMessage java.lang.String   true Success message to look for in the process output, if the success message is not found then then a task exception is thrown.
targetServerNames java.lang.String server1,server2 true Comma separated list of target servers.
targetServerSshPassphrase java.lang.String   true Target SSH passphrase (if required).
targetServerSshPassword java.lang.String   true Target SSH Password (if required).
targetServerSshPort java.lang.String 22 false SSH Port on the target server.
targetServerSshTimeout java.lang.String 1200000 false Timeout on the target server(s) in milliseconds.
targetServerSshUser java.lang.String sshUser false Target SSH user.


Back to Top

StartSiebelWebServersTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.StartSiebelWebServersTask
Category Oracle Siebel 8

Start Siebel Web Servers Task

Description

This task will concurrently execute a "startapa" command on all the Siebel Web Servers defined in the Siebel Environment.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
errorFilePath java.lang.String   true Project relative path to a file containing a list of error messages (on each line of the file) to look for in the process output, if one of the error messages is found then a task exception is thrown.
errorMessage java.lang.String   true Error message to look for in the process output, if the error message is found then then a task exception is thrown.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
siebelWebsrvrPath java.lang.String /siebel/sweapp/HTTPServer false The path to the Siebel Web Server.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sshIdentityFile java.lang.String /path/to/identity/file true Local Identity file.
successFilePath java.lang.String   true Project relative path to a file containing a list of success messages (on each line of the file) to look for in the process output, if one of the success strings is found then a task exception is not thrown.
successMessage java.lang.String   true Success message to look for in the process output, if the success message is not found then then a task exception is thrown.
targetServerNames java.lang.String server1,server2 true Comma separated list of target servers.
targetServerSshPassphrase java.lang.String   true Target SSH passphrase (if required).
targetServerSshPassword java.lang.String   true Target SSH Password (if required).
targetServerSshPort java.lang.String 22 false SSH Port on the target server.
targetServerSshTimeout java.lang.String 1200000 false Timeout on the target server(s) in milliseconds.
targetServerSshUser java.lang.String sshUser false Target SSH user.


Back to Top

StopGatewayServersTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.StopGatewayServersTask
Category Oracle Siebel 8

Stop Siebel Gateway Name Servers Task

Description

This task is like the task ExecuteGatewayServerCommandTask except the command is fixed to: stop_ns. It will execute a stop_ns command on all the target servers.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
errorFilePath java.lang.String   true Project relative path to a file containing a list of error messages (on each line of the file) to look for in the process output, if one of the error messages is found then a task exception is thrown.
errorMessage java.lang.String   true Error message to look for in the process output, if the error message is found then then a task exception is thrown.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
siebelGtwySrvrPath java.lang.String /siebel/gtwysrvr false The path to the Siebel Gateway Server.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sshIdentityFile java.lang.String /path/to/identity/file true Local Identity file.
successFilePath java.lang.String   true Project relative path to a file containing a list of success messages (on each line of the file) to look for in the process output, if one of the success strings is found then a task exception is not thrown.
successMessage java.lang.String   true Success message to look for in the process output, if the success message is not found then then a task exception is thrown.
targetGatewayServerNames java.lang.String server1,server2 true Comma separated list of target servers, if not set then uses the Siebel Environment Gateway Server hostname
targetServerSshPassphrase java.lang.String   true Target SSH passphrase (if required).
targetServerSshPassword java.lang.String   true Target SSH Password (if required).
targetServerSshPort java.lang.String 22 false SSH Port on the target server.
targetServerSshTimeout java.lang.String 1200000 false Timeout on the target server(s) in milliseconds.
targetServerSshUser java.lang.String sshUser false Target SSH user.


Back to Top

StopGatewayServerTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.StopGatewayServerTask
Category Oracle Siebel 8

Stop Siebel Gateway Name Server Task

Description

This task is like the task ExecuteGatewayServerCommandTask except the command is fixed to: stop_ns. It will execute a stop_ns command on the Siebel Gateway Name Server.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
errorFilePath java.lang.String   true Project relative path to a file containing a list of error messages (on each line of the file) to look for in the process output, if one of the error messages is found then a task exception is thrown.
errorMessage java.lang.String   true Error message to look for in the process output, if the error message is found then then a task exception is thrown.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
siebelGtwySrvrPath java.lang.String /siebel/gtwysrvr false The path to the Siebel Gateway Server.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
successFilePath java.lang.String   true Project relative path to a file containing a list of success messages (on each line of the file) to look for in the process output, if one of the success strings is found then a task exception is not thrown.
successMessage java.lang.String   true Success message to look for in the process output, if the success message is not found then then a task exception is thrown.


Back to Top

StopSiebelServersTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.StopSiebelServersTask
Category Oracle Siebel 8

Stop Siebel Servers Task

Description

This task is like the task ExecuteSiebelServerGroupCommandTask, except the command is fixed to "stop_server all". This task will concurrently execute a "stop_server all" command on all Siebel Servers defined in the Siebel Environment.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
errorFilePath java.lang.String   true Project relative path to a file containing a list of error messages (on each line of the file) to look for in the process output, if one of the error messages is found then a task exception is thrown.
errorMessage java.lang.String   true Error message to look for in the process output, if the error message is found then then a task exception is thrown.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
siebelSrvrPath java.lang.String /siebel/siebsrvr false The path to the Siebel Server.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sshIdentityFile java.lang.String /path/to/identity/file true Local Identity file.
successFilePath java.lang.String   true Project relative path to a file containing a list of success messages (on each line of the file) to look for in the process output, if one of the success strings is found then a task exception is not thrown.
successMessage java.lang.String   true Success message to look for in the process output, if the success message is not found then then a task exception is thrown.
targetServerNames java.lang.String server1,server2 true Comma separated list of target servers.
targetServerSshPassphrase java.lang.String   true Target SSH passphrase (if required).
targetServerSshPassword java.lang.String   true Target SSH Password (if required).
targetServerSshPort java.lang.String 22 false SSH Port on the target server.
targetServerSshTimeout java.lang.String 1200000 false Timeout on the target server(s) in milliseconds.
targetServerSshUser java.lang.String sshUser false Target SSH user.


Back to Top

StopSiebelWebServersTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.StopSiebelWebServersTask
Category Oracle Siebel 8

Stop Siebel Web Servers Task

Description

This task will concurrently execute a "stopapa" command on all the Siebel Web Servers defined in the Siebel Environment.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
errorFilePath java.lang.String   true Project relative path to a file containing a list of error messages (on each line of the file) to look for in the process output, if one of the error messages is found then a task exception is thrown.
errorMessage java.lang.String   true Error message to look for in the process output, if the error message is found then then a task exception is thrown.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
siebelWebsrvrPath java.lang.String /siebel/sweapp/HTTPServer false The path to the Siebel Web Server.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sshIdentityFile java.lang.String /path/to/identity/file true Local Identity file.
successFilePath java.lang.String   true Project relative path to a file containing a list of success messages (on each line of the file) to look for in the process output, if one of the success strings is found then a task exception is not thrown.
successMessage java.lang.String   true Success message to look for in the process output, if the success message is not found then then a task exception is thrown.
targetServerNames java.lang.String server1,server2 true Comma separated list of target servers.
targetServerSshPassphrase java.lang.String   true Target SSH passphrase (if required).
targetServerSshPassword java.lang.String   true Target SSH Password (if required).
targetServerSshPort java.lang.String 22 false SSH Port on the target server.
targetServerSshTimeout java.lang.String 1200000 false Timeout on the target server(s) in milliseconds.
targetServerSshUser java.lang.String sshUser false Target SSH user.


Back to Top

SymbolicUrlChangeTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.SymbolicUrlChangeTask
Category Oracle Siebel 8

Symbolic Url Change Task

Description

This task will create a Siebel Java Data bean to connect to the Siebel Server. The connection details are taken from the Siebel environment settings, these settings can be overridden by the settings in this task. This task will load the Siebel business object "WI Symbolic URL" and its Siebel business component "WI Symbolic URL". It will then search for a Symbolic URL by the [symbolicUrlName] resource value. If a Symbolic URL is found, then its URL will be updated with the [newUrl] resource value.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
newUrl java.lang.String   false A new symbolic Url.
sadminPassword java.lang.String SADMIN true Password for Siebel Administration User (default username: SADMIN).
sadminUserName java.lang.String SADMIN true Name of the Siebel admin user to connect with (default username: SADMIN).
siebelAomName java.lang.String PSCcObjMgr_enu true Name of the Siebel Application Object Manager Component.
siebelEnterpriseServerName java.lang.String En_SblSIT true Name of the Siebel Enterprise Server. Should reflect the Environment Name (Ex: Dev or QA etc...)
siebelPropertiesPath java.lang.String   true The package relative path to the siebel.properties file which is used by the Java Data Bean for the connection properties e.g. siebel.connection.string, siebel.user.name, siebel.user.password, siebel.user.language, siebel.conmgr.txtimeout, siebel.conmgr.poolsize, siebel.conmgr.sesstimeout and siebel.conmgr.retry. If not set the Siebel environment settings are used.
siebelServerConnectionLanguage java.lang.String enu true Siebel Server Connection Language.
siebelServerConnectionPort java.lang.Integer 2321 true Connection port number of the Siebel Server.
siebelServerNames java.lang.String localhost true Comma separated list of Siebel Server hostnames or IP addresses.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
symbolicUrlName java.lang.String   false A symbolic Url name, which is used as the search specification to find the for the Symbolic Url in the business component to update.


Back to Top

UpdateBusinessComponentValueTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.UpdateBusinessComponentValueTask
Category Oracle Siebel 8

Update Business Component Value Task

Description

This task will create a Siebel Java Data bean to connect to the Siebel Server. The connection details are taken from the Siebel environment settings, these settings can be overridden by the settings in this task. This task will load the Siebel business object [businessObjectName] resource value and its Siebel business component [businessComponentName] resource value. It will then search for a resource by the [searchColumnValue] resource value. If a record is found, then its [updateColumnName] resource value will be updated with the [newValue] resource value.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
businessComponentName java.lang.String   false A business component name loaded from the business object, used to update the value.
businessObjectName java.lang.String   false A business business object name, used to load the business component.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
newValue java.lang.String   false A new value to update.
sadminPassword java.lang.String SADMIN true Password for Siebel Administration User (default username: SADMIN).
sadminUserName java.lang.String SADMIN true Name of the Siebel admin user to connect with (default username: SADMIN).
searchColumnName java.lang.String   false A column name which is used as the search specification column to find the for the record in the business component to update.
searchColumnValue java.lang.String   false A value which is used as the search specification to find the for the record in the business component to update.
siebelAomName java.lang.String PSCcObjMgr_enu true Name of the Siebel Application Object Manager Component.
siebelEnterpriseServerName java.lang.String En_SblSIT true Name of the Siebel Enterprise Server. Should reflect the Environment Name (Ex: Dev or QA etc...)
siebelPropertiesPath java.lang.String   true The package relative path to the siebel.properties file which is used by the Java Data Bean for the connection properties e.g. siebel.connection.string, siebel.user.name, siebel.user.password, siebel.user.language, siebel.conmgr.txtimeout, siebel.conmgr.poolsize, siebel.conmgr.sesstimeout and siebel.conmgr.retry. If not set the Siebel environment settings are used.
siebelServerConnectionLanguage java.lang.String enu true Siebel Server Connection Language.
siebelServerConnectionPort java.lang.Integer 2321 true Connection port number of the Siebel Server.
siebelServerNames java.lang.String localhost true Comma separated list of Siebel Server hostnames or IP addresses.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
updateColumnName java.lang.String   false A column name, which is used as the column to update the value in the business component.


Back to Top

WorkflowBatchComponentTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.WorkflowBatchComponentTask
Category Oracle Siebel 8

Workflow Batch Component Task

Description

This task will execute a Siebel Server srvrmgr command based on the input of a configuration file.
An example of the server manager command based on the input of the properties file:

./srvrmgr /g AIXDEV01 /e En_SblDEMO /u SADMIN /p SADMIN /c "run task for component WfProcBatchMgr server localhost with ProcessName="Process ABC",SearchSpec="[Case] IS NOT NULL",TraceFlags=4".

The properties file should be formatted as follows:

Description=[This is description of the job - optional]
JOBNAME=[This is a name of the job - optional]
ProcessName=[This is the process name - mandatory] e.g. Process ABC
SearchSpec=[This is the search specification - optional] e.g. [Case] IS NOT NULL
TraceFlags=[This is the log level - optional, defaults to 4] e.g. 4
WFBATCHCOMP=[This is the workflow batch component - mandatory] e.g. WfProcBatchMgr


You can optionally specify an error string to find in the output.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
errorFilePath java.lang.String   true Project relative path to a file containing a list of error messages (on each line of the file) to look for in the process output, if one of the error messages is found then a task exception is thrown.
errorMessage java.lang.String   true Error message to look for in the process output, if the error message is found then then a task exception is thrown.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
gatewayHostname java.lang.String localhost true The host DNS or IP address of the Siebel Gateway Server.
relativeWorkFlowBatchConfigFile java.lang.String   false Path to relative work flow batch configuration file. This file contains the job configuration properties.
sadminPassword java.lang.String SADMIN true Password for Siebel Administration User (default username: SADMIN).
sadminUserName java.lang.String SADMIN true Name of the Siebel admin user to connect with (default username: SADMIN).
siebelEnterpriseServerName java.lang.String En_SblSIT true Name of the Siebel Enterprise Server. Should reflect the Environment Name (Ex: Dev or QA etc...)
siebelSrvrPath java.lang.String /siebel/siebsrvr false The path to the Siebel Server.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
successFilePath java.lang.String   true Project relative path to a file containing a list of success messages (on each line of the file) to look for in the process output, if one of the success strings is found then a task exception is not thrown.
successMessage java.lang.String   true Success message to look for in the process output, if the success message is not found then then a task exception is thrown.
targetServerNames java.lang.String server1,server2 true Comma separated list of target servers.


Back to Top

AutoDeployTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.cmec.AutoDeployTask
Category SIEBEL-CMEC

Auto Deploy Task

Description

This task will create a Siebel Java Data bean to connect to the Siebel Server. The connection details are taken from the Siebel environment settings, these settings can be overridden by the settings in this task. This task will run the auto deploy task.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
errorFilePath java.lang.String   true The package relative or absolute path to the error file. The structure of this file is: on each line there is an entity data name followed by a hash character followed by the error message, ie. EmployeeResp#SER_NUM:24 - Record not found with the provided key
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
inputFilesDirectory java.lang.String /siebel/RefDataAutomation/DataFiles false The package relative or absolute path to the input files directory containing the Action.xls file and other *.xls input data files.
refCatalogueXmlPath java.lang.String /siebel/RefDataAutomation/RefCatalogue/Reference_Catalogue.xml false The package relative or absolute path to the auto deploy reference data catalogue.
sadminPassword java.lang.String SADMIN true Password for Siebel Administration User (default username: SADMIN).
sadminUserName java.lang.String SADMIN true Name of the Siebel admin user to connect with (default username: SADMIN).
siebelAomName java.lang.String PSCcObjMgr_enu true Name of the Siebel Application Object Manager Component.
siebelEnterpriseServerName java.lang.String En_SblSIT true Name of the Siebel Enterprise Server. Should reflect the Environment Name (Ex: Dev or QA etc...)
siebelPropertiesPath java.lang.String   true The package relative path to the siebel.properties file which is used by the Java Data Bean for the connection properties e.g. siebel.connection.string, siebel.user.name, siebel.user.password, siebel.user.language, siebel.conmgr.txtimeout, siebel.conmgr.poolsize, siebel.conmgr.sesstimeout and siebel.conmgr.retry. If not set the Siebel environment settings are used.
siebelServerConnectionLanguage java.lang.String enu true Siebel Server Connection Language.
siebelServerConnectionPort java.lang.Integer 2321 true Connection port number of the Siebel Server.
siebelServerNames java.lang.String localhost true Comma separated list of Siebel Server hostnames or IP addresses.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.


Back to Top

DVRImportExportTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.cmec.DVRImportExportTask
Category SIEBEL-CMEC

Export Siebel Message Task

Description

This task will create a Siebel Java Data bean to connect to the Siebel Server. The connection details are taken from the Siebel environment settings, these settings can be overridden by the settings in this task. This task will run the auto deploy export Siebel message task.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
inputFilesDirectory java.lang.String /siebel/RefDataAutomation/DataFiles false The package relative or absolute path to the input files directory containing the Action.xls file and other *.xls input data files.
refCatalogueXmlPath java.lang.String /siebel/RefDataAutomation/RefCatalogue/Reference_Catalogue.xml false The package relative or absolute path to the auto deploy reference data catalogue.
sadminPassword java.lang.String SADMIN true Password for Siebel Administration User (default username: SADMIN).
sadminUserName java.lang.String SADMIN true Name of the Siebel admin user to connect with (default username: SADMIN).
siebelAomName java.lang.String PSCcObjMgr_enu true Name of the Siebel Application Object Manager Component.
siebelEnterpriseServerName java.lang.String En_SblSIT true Name of the Siebel Enterprise Server. Should reflect the Environment Name (Ex: Dev or QA etc...)
siebelPropertiesPath java.lang.String   true The package relative path to the siebel.properties file which is used by the Java Data Bean for the connection properties e.g. siebel.connection.string, siebel.user.name, siebel.user.password, siebel.user.language, siebel.conmgr.txtimeout, siebel.conmgr.poolsize, siebel.conmgr.sesstimeout and siebel.conmgr.retry. If not set the Siebel environment settings are used.
siebelServerConnectionLanguage java.lang.String enu true Siebel Server Connection Language.
siebelServerConnectionPort java.lang.Integer 2321 true Connection port number of the Siebel Server.
siebelServerNames java.lang.String localhost true Comma separated list of Siebel Server hostnames or IP addresses.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.


Back to Top

EstablishConnectionTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.cmec.EstablishConnectionTask
Category SIEBEL-CMEC

Establish Connection Task

Description

This task will create a Siebel Java Data bean to connect to the Siebel Server. The connection details are taken from the Siebel environment settings, these settings can be overridden by the settings in this task. This task will test the connection to a Siebel Data Bean.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
sadminPassword java.lang.String SADMIN true Password for Siebel Administration User (default username: SADMIN).
sadminUserName java.lang.String SADMIN true Name of the Siebel admin user to connect with (default username: SADMIN).
siebelAomName java.lang.String PSCcObjMgr_enu true Name of the Siebel Application Object Manager Component.
siebelEnterpriseServerName java.lang.String En_SblSIT true Name of the Siebel Enterprise Server. Should reflect the Environment Name (Ex: Dev or QA etc...)
siebelPropertiesPath java.lang.String   true The package relative path to the siebel.properties file which is used by the Java Data Bean for the connection properties e.g. siebel.connection.string, siebel.user.name, siebel.user.password, siebel.user.language, siebel.conmgr.txtimeout, siebel.conmgr.poolsize, siebel.conmgr.sesstimeout and siebel.conmgr.retry. If not set the Siebel environment settings are used.
siebelServerConnectionLanguage java.lang.String enu true Siebel Server Connection Language.
siebelServerConnectionPort java.lang.Integer 2321 true Connection port number of the Siebel Server.
siebelServerNames java.lang.String localhost true Comma separated list of Siebel Server hostnames or IP addresses.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.


Back to Top

PolicyAutomationValidationTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.cmec.PolicyAutomationValidationTask
Category SIEBEL-CMEC

Policy Automation Validation Task

Description

This task will create a Siebel Java Data bean to connect to the Siebel Server. The connection details are taken from the Siebel environment settings, these settings can be overridden by the settings in this task. Once a connection is established the "Policy Automation" Siebel Service is retrieved to validate the mappings for the policies using the mapping name. The service will invoke the "Validate Mapping" method on the service.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean false false This task will not fail the deployment on error if set to false.
mappingNames java.lang.String   false A comma separate list of mapping names used by the Policy Automation Service to validate.
sadminPassword java.lang.String SADMIN true Password for Siebel Administration User (default username: SADMIN).
sadminUserName java.lang.String SADMIN true Name of the Siebel admin user to connect with (default username: SADMIN).
siebelAomName java.lang.String PSCcObjMgr_enu true Name of the Siebel Application Object Manager Component.
siebelEnterpriseServerName java.lang.String En_SblSIT true Name of the Siebel Enterprise Server. Should reflect the Environment Name (Ex: Dev or QA etc...)
siebelPropertiesPath java.lang.String   true The package relative path to the siebel.properties file which is used by the Java Data Bean for the connection properties e.g. siebel.connection.string, siebel.user.name, siebel.user.password, siebel.user.language, siebel.conmgr.txtimeout, siebel.conmgr.poolsize, siebel.conmgr.sesstimeout and siebel.conmgr.retry. If not set the Siebel environment settings are used.
siebelServerConnectionLanguage java.lang.String enu true Siebel Server Connection Language.
siebelServerConnectionPort java.lang.Integer 2321 true Connection port number of the Siebel Server.
siebelServerNames java.lang.String localhost true Comma separated list of Siebel Server hostnames or IP addresses.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.


Back to Top

ValidateReferenceDataTask

Class Name com.midvision.rapiddeploy.plugins.products.oracle.siebel8113.task.cmec.ValidateReferenceDataTask
Category SIEBEL-CMEC

Validate Reference Data Task

Description

This task will validate the CSV or XLS data files, used as the input to the auto deploy task.

Resources/Parameter

The following resources/parameters may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
inputFilesDirectory java.lang.String /siebel/RefDataAutomation/DataFiles false The package relative or absolute path to the input files directory containing the Action.xls file and other *.xls input data files.
refCatalogueXmlPath java.lang.String /siebel/RefDataAutomation/RefCatalogue/Reference_Catalogue.xml false The package relative or absolute path to the auto deploy reference data catalogue.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.