You can invoke a subset of the RPS Manager functionality from a Web service consumer by using the RPSAdminWS application provided by JADE in the JadeMonitorSchema schema.
Before you run the RPSAdminWS application provided in the JadeMonitorSchema, you will probably want to override the default application parameters; for example, the connection name and the port number. You can run
The JadeWebConfigurator application that is also provided in the JadeMonitorSchema enables you to create and maintain a configuration file for the RPSAdminWS application. For details, see Chapter 3, "
The following example is the command line to run the RPSAdminWS application.
jade.exe path=s:\jade\system ini=c:\jade\system\jade.ini schema=JadeMonitorSchema app=RPSAdminWS
Alternatively, you can create a shortcut to run this application from the JADE installation directory in which the JADE executables were installed (which defaults to the bin directory).
The JADE Web Application Monitor is then displayed. For details, see Chapter 2, "
The Web service provider is RpsAdminService. A default WSDL, RPSAdmin.wsdl, is provided in the wsdl folder in the JADE release medium.
You can execute the
If you specify a user Datapump application, you can execute the
Running an RPS extract on an SDS node will cause tracking to be stopped during the extract.
If you extract the data via the RPS Manager on the SDS node, you must specify the user Datapump application and schema or the <default> value in the
The following Web services methods are exposed.
extractData, which provides the same functionality as the
extractData(tableName: String; executionLocation: Integer; scriptFilePath: String; dataFilesPath: String; rdbDataFilesPath: String; rdbName: String; loadHistoricalTables: Boolean; serverName: String; extractWorkers: Integer) webService;
This method extracts the specified table name or all tables (that is, if the value of the tableName parameter is null), using the specified parameter values.
The values of the executionLocation parameter are defined by the following
Load_ServerExecute (0)
Load_ClientExecute (1)
extractDataAll, which provides the same functionality as the
extractDataAll(executionLocation: Integer; scriptFilePath: String; dataFilesPath: String; rdbDataFilesPath: String; rdbName: String; extractHistoricalTables: Boolean; serverName: String; extractWorkers: Integer; extractOrder: Integer; extractFirst: String; userDataPumpSchema: String; userDataPumpApp: String): Process;
This method extracts all tables in the RPS mapping, using the specified parameter values. The extractOrder parameter specifies the order in which the tables are to be extracted, using the following
ExtractOrderDefault (0), indicating that no extract order is specified.
ExtractOrderClassInstances (1), which outputs tables in order of the number of instances of the class, from highest to lowest.
Determining the number of instances may delay the start of extraction.
ExtractOrderSelectedFirst (2), which first outputs tables specified in the extractFirst parameter and then uses the default order.
The userDataPumpSchema and userDataPumpApp parameters specify the user application to be used as the Datapump application. This application must be correctly configured as a user data pump. To use the default JADE Datapump application, the parameter values should be empty strings ("").
For details about worker allocation extraction order, see "Selecting Tables" under "Extracting Data from the JADE Database", earlier in this chapter.
When specifying values for the extractFirst parameter, table names are delimited by semicolons.
extractDataUsingIniFileOptions, which provides the same functionality as the
extractDataUsingIniFileOptions(tableName: String) webService;
This method extracts the specified table name or all tables (that is, if the value of the tableName parameter is null), using the values of parameters in the [
getDatabaseParameters, which provides the same functionality as the
getDatabaseParameters(schemaName: String output; rpsMappingName: String output; storageMode: Integer output) webService;
This method returns the schema name, RPS mapping name, and the storage mode of the RPS node.
rpsExtractData, which provides the same functionality as the
rpsExtractData(tableName: String; executionLocation: Integer; scriptFilePath: String; dataFilesPath: String; rdbDataFilesPath: String; rdbName: String; loadHistoricalTables: Boolean; serverName: String; extractWorkers: Integer) webService;
This method extracts the specified table name or all tables (that is, if the value of the tableName parameter is null), using the specified parameter values. The values of the executionLocation parameter are defined by the following
Load_ServerExecute (0)
Load_ClientExecute (1)
rpsExtractDataAll, which provides the same functionality as the
rpsExtractDataAll(executionLocation: Integer; scriptFilePath: String; dataFilesPath: String; rdbDataFilesPath: String; rdbName: String; extractHistoricalTables: Boolean; serverName: String; extractWorkers: Integer; extractOrder: Integer; extractFirst: String; userDataPumpSchema: String; userDataPumpApp: String): Process;
This method extracts all tables in the RPS mapping, using the specified parameter values.
The extractOrder parameter specifies the order in which the tables are to be extracted, using the following
ExtractOrderDefault (0), indicating that no extract order is specified.
ExtractOrderClassInstances (1), which outputs tables in order of the number of instances of the class, from highest to lowest.
Determining the number of instances may delay the start of extraction.
ExtractOrderSelectedFirst (2), which first outputs tables specified in the extractFirst parameter and then uses the default order.
For details about worker allocation extraction order, see "Selecting Tables" under "Extracting Data from the JADE Database", earlier in this chapter.
When specifying values for the extractFirst parameter, table names are delimited by semicolons.
rpsExtractDataUsingIniFileOptions, which provides the same functionality as the
rpsExtractDataUsingIniFileOptions(tableName: String) webService;
This method extracts the specified table name or all tables (that is, if the value of the tableName parameter is null), using the values of parameters in the [
startDataPump, which provides the same functionality as the
startDataPump(userName: String; password: String) webService;
This method starts the RPS Datapump application on the RPS server node for the user name and corresponding password.
stopDataPump, which provides the same functionality as the
stopDataPump() webService;
This method stops the RPS Datapump application on the RPS server node.