Calling the RPS Manager from a Web Service Consumer

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.

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, "Configuring Web Applications", in the Web Application Guide.

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, "Monitoring Your Web Sessions", in the Web Application Guide. For more details, see the SOAP Web Services white paper on the Jade website at https://www.jadeplatform.tech/developer-centre/learn/whitepapers.

The web service provider is RpsAdminService. A default WSDL, RPSAdmin.wsdl, is provided in the wsdl folder in the Jade Platform release medium.

You can execute the RelationalView class extractData and extractDataAll methods on an SDS secondary or an RPS node, but not on the primary node.

If you specify a user Datapump application, you can execute the JadeDatabaseAdmin class rpsExtractDataAll method on an SDS or RPS node only, not on the primary node.

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 DataPumpApplication parameter in the [JadeRps] section of the Jade initialization file.

The following web services methods are exposed.

extractData, which provides the same functionality as the RelationalView class extractData method and which has the following signature.
```
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 RelationalView class constants.
- Load_ServerExecute (0)
- Load_ClientExecute (1)
extractDataAll, which provides the same functionality as the RelationalView class extractDataAll method and which has the following signature.
```
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 RelationalView class constants.
- 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 RelationalView class extractDataUsingIniFileOptions method and which has the following signature.
```
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 [JadeRps] section of the Jade initialization file.
getDatabaseParameters, which provides the same functionality as the JadeDatabaseAdmin class rpsGetDatabaseParameters method and which has the following signature.
```
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 JadeDatabaseAdmin class rpsExtractData method and which has the following signature.
```
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 RelationalView class constants.
- Load_ServerExecute (0)
- Load_ClientExecute (1)
rpsExtractDataAll, which provides the same functionality as the JadeDatabaseAdmin class rpsExtractDataAll method and which has the following signature.
```
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 JadeDatabaseAdmin class constants.
- 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 JadeDatabaseAdmin class rpsExtractDataUsingIniFileOptions method and which has the following signature.
```
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 [JadeRps] section of the Jade initialization file.
startDataPump, which provides the same functionality as the JadeDatabaseAdmin class rpsStartDataPump method and which has the following signature.
```
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 JadeDatabaseAdmin class rpsStopDataPump method and which has the following signature.
```
stopDataPump() webService;
```
This method stops the RPS Datapump application on the RPS server node.