Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

WhereScape RED provides a command line interface called WslMetadataService.exe that allows users to access the metadata servicestartup a REST based WhereScape Metadata Service.  This is the is the underlying REST service which feeds the WhereScape RED Template Engine whenever a template operation is performed. The tool is available in the RED Windows installation directory, this tool can also be called from Windows scripting languages or from a script added to RED UI..

Endpoints

The REST service has the following endpoints:

  • jobsById
  • jobsByName
  • jobsExportByName
  • changedJobs
  • tasksById
  • objectIds
  • objectsById
  • objectsByName
  • objectsExportByName
  • sourcemappingsById
  • viewaliasesById
  • targetsById
  • metadataConnection
  • types
  • options
  • usersById


Command Arguments

Options for connecting to the metadata server:

Command

Description

Metadata connection options
--meta-dsnSet metadata DSN
--meta-dsn-archThe architecture of the ODBC DSN. Valid values are 32 and 64. Defaults to 32 if not specified.
--meta-con-stringSset metadata Connection String (if specified, username, password, dsn can be optional)
--red-profileSet Red Profile path
--meta-userSet metadata login username (use OS authentication if omitted)
--meta-password)Set metadata login password (use OS authentication if omitted
--meta-schemaSet metadata schema (including trailing dot)
--meta-databaseSet metadata database
 --meta-db-type

Set metadata database type, accepted values can be:

  • 2: SQL Server
  • 3: DB2
  • 4: Teradata
  • 5: Oracle
  • 14: PostgreSQL
--ws-userSet metadata user name
HTTP options
--insecureAllow connections without authorization
--listen-portPort number to listen on (defaults to first unused from 8080)
General options
--helpProduce help message and exit
--versionReport version information and exit
--log-levelSet log level (0 is very quiet, 9 is very noisy)


Example script to invoke and query the service 

The following example shows a script that allows you to connect to the metadata server and get json data

...