Portus Version 2012-12-17
 —  Administration  —

The Portus (legacy) Servers View

The Servers View lists all defined servers along with their status.

This view is your top level of configuration of one or many Portus servers.

Note:
The Servers view is part of the Portus "legacy" perspective. This perspective is superseded by the new "Portus perspective", you are strongly encouraged to familiarise yourself with, and start using the new perspective as early as possible, only the latter will be enhanced further some features are available in the Portus perspective only.


Working with the Servers View

There are 2 ways to perform actions on a defined server.

graphics/srvVw01_portus.png

Function Description
Refresh Configuration A server's configuration may be modified outside of your own Control Centre session, thus it may be necessary to refresh the local copy.
Disconnect from Server When many servers are defined, "inactive" servers will still be contacted when you start the Control Centre. This may take quite a while until the TCP/IP timeout is reached, so the connection to knowingly "inactive" servers can be "suspended", which will cause them to be ignored until the connection is reestablished. For disconnected servers the "Disconnect" context menu item will change to "Connect to Server".
Set Credentials for Server Set the login credentials (HTTP and SOAP User Id and password) for secured Portus servers.

Important:
To use HTTP credentials you must have a <Location /configurationService> directive enabled.

Save current Configuration to server file Changes applied to a Portus Server configuration from the Control Centre are volatile, thus need to be "saved" - written to the currently active or a different configuration file, otherwise changes made on-the-fly are lost when the server is restarted.
Import Configuration into Control Centre Takes a snapshot of the current "online" configuration, for backup purposes (locally or stored in a CVS repository for version control, e.g.), copying or exporting to a different server etc.
Export Configuration from Control Centre Sends (exports) a local copy of an imported configuration to a Portus server. The server must be restarted for the exported configuration to be activated.
Create new Services Create Portus Resource related definition elements - DataViews and XML Schemata (XSDs) from native resource definition data, e.g. an Adabas FDT, SQL Tables, etc
Export Service Definition(s) to server Export Portus Resource related definition elements - DataViews, XML Schemata (XSDs) and Stylesheets (XSLs).
Remove Server definition Deletes the selected entry from the Servers View.
Add new Portus connection Define a new Portus server to the Control Centre

Top of page

Refresh the Portus configuration

When a Portus Server configuration is modified "on-the-fly", for example by modifying, adding or deleting resources, these changes are volatile, they are not preserved over a server restart. Additionally, a server configuration may have been modified by someone else. In either case, your local representation of the Portus server configuration may no longer be accurate, issue a Refresh to synchronize it by selecting the "Refresh Configuration" option on the context menu. A message will be written to the Action Log as well as the status line after the refresh operation is completed.

Top of page

Save current Configuration to server file

As the Portus Server configuration is volatile - not preserved over a restart - the configuration has to be "saved" (written to disc) in order to have it available for subsequent server executions. Selecting the "Save current Configuration to server file" function from the context menu brings up the following dialog:

graphics/srvVw20.png

Leave the Save as field empty to overwrite the currently active configuration file, or opt to write to a different file (specify the name in the "Save as" field), in which case the respective Portus Server environment variables have to be adjusted to point to the new file. Click "Continue" to save the configuration, the successful operation will be confirmed by a message in the status line.

To include unpublished configuration changes in the saved copy, check the respective box.

Top of page

Import the Portus Configuration from server

The current "live" Portus Server configuration can be imported to the local file system, e.g. for archiving purposes (locally, saved in a CVS repository etc.), copying / exporting to another Portus server etc.

  1. Select the "Import Configuration from server" option from the context menu

  2. Select a target directory, click OK.

    graphics/srvVw30.png

  3. Successful import will be confirmed with a message in the status line as well as the Log View

    graphics/srvVw31.png

Top of page

Export the Portus Server configuration

An imported configuration can be exported back to any Portus Server.

  1. Select the "Export Configuration to server" option from the context menu

  2. Select an exported configuration, click "OK".

    graphics/srvVw40.png

  3. Specify the export destination, either the currently active, or a different Portus configuration file, click "Continue" to perform the export operation.

    graphics/srvVw41.png

  4. Successful export will be confirmed with a message in the status line

    graphics/srvVw42.png

Top of page

Export Portus WebService definitions

Export Portus WebService related definition elements - DataViews (XRDs) and/or XML Schemata (XSDs) and/or Stylesheets (XSLs).

  1. Select the export WebService Definitions option from the context menu

  2. Select a DataView (XRD), Schema (XSD) or Stylesheet (XSL), click OK.

graphics/srvVw65.png

Top of page

Remove a Portus Server entry

  1. Select the "Remove Server definition" option from the context menu

  2. Confirm by clicking the "Yes" button.

    graphics/srvVw50.png

  3. The server entry is now deleted and removed from the Servers View

Top of page

Create new Services

  1. Select the "Creat new Services" option from the context menu

  2. graphics/ccdisc_serv_cr.png

    Select the driver to be used for creating/importing the resource(s), then click 'Next'.

Example: Create a new Adabas WebService

For Adabas drivers, the following dialog is presented

graphics/ccdisc_serv_cr_adabas.png

Specify

For a comprehensive description please refer to the Portus WebService Creation section.

Example: Create a new MySQL WebService

For MySQL, PostgreSQL, and other ODBC-based Drivers, the following dialog will be displayed

graphics/ccdisc20.png

Specify

Click the Discover button to start the import/generation process.

When "Options for generated Service name" is checked, the following dialog will appear after having clicked the Discover button

graphics/ccdisc2a.png

Here you can control how the names of automatically created WebServices will be assembled. Specify the replacement character for whitespaces in table names, decide if (and what) prefix is to be attached, select which catalog elements describing a table are to be included in the WebService name.

Click Continue to use the current settings as per this dialog, or click Cancel to use the default settings.

When "Show all table types" is checked, the following dialog will appear after having clicked the Discover button

Click Continue to use the current settings as per this dialog, or click Cancel to use the default settings.

WebService definition(s), DataViews as well as XSDs, for the selected file(s) will be generated

For a comprehensive description please refer to the Portus WebService Creation section.

Top of page

Modify the Portus Server definition entry

In this section you can modify the friendly-name, host and port that the Portus server is running on. You may also view some detailed information about the server.

To modify the Portus server entry:

  1. In the Portus Server view, left-click the server you wish to modify.

  2. Select the General tab in the Properties view

  3. Modify parameters as required, click Save.

    graphics/srvVw55.png

Note: you can also view the Portus Status, and license information here too. This information is not modifable.

Top of page

Modify Global -> Security Options

In this section located in the Global properties you can set the Security Level that Portus runs at.

Important:
We recommend you contact your Portus support team before modifying these parameters.

To open the Security view, left-click the server you wish to modify. In the Properties view, select the Global tab. Security options are in the Security group.

There are 4 security levels that Portus can run at

  1. None: No Portus security.

  2. Userid: All requests must have a user ID.

  3. Password: All requests must have a user ID and password.

  4. SSLCert: All requests must have a SSL Certficate.

Under normal circumstances the user will be authenticated by sending the credentials to the underlying resource ( for example the ODBC database). It is also possible to provide a 3rd party DLL which can authenticate the credentials. This DLL name should be added in the Manager text box.

graphics/srvVw12.png

Top of page

Modify Global -> Transactional Options

In this section you can set the Transaction Manager that Portus uses to handle data integrity.

Important:
We recommend you contact your Portus support team before modifying these parameters.

To open the Transaction view, left-click the server you wish to modify. In the Properties view, select the Global tab. Transaction options are in the Transaction group.

graphics/srvVw13.png

Top of page

Modify Global -> Settings

In this section you can set threshold values for Portus global variables.

Left-click the server you wish to modify. In the Properties view, select the Global tab. Server settings are in the Settings group.

graphics/srvVw17.png

The following can be set here

Top of page

Modify tracing / messaging options

The message level set for a Portus Server determines the amount and detail of information written to the server log.

Important:
Trace options are debugging instruments which should not be modified unless instructed to do so by support personnel, continuous tracing will adversely effect the performance of the Portus Server.

To change either the message level or trace options:

  1. Select the "Tracing" tab from the Properties view

  2. Modify the message level or tracing option(s), as appropriate, click "Apply" to send the changes to the Portus Server.

    graphics/srvVw10.png

Top of page

Add / Modify Drivers

This section describes how you add/remove/modify the drivers that Portus uses to talk to the underlying resource whether that be Adabas, Natural, MySQL, PostgreSQL, etc

To open the Drivers view, left-click the server you wish to modify. In the Properties view, select the Drivers tab.

From here you can add, remove and modify drivers, or view detailed information about a particular driver.

graphics/srvVw14.png

You may left-click a driver entry and select Details to display more information about this driver.

To modify an existing driver, left-click the driver,and select Modify

To add a new driver, click the Add... button.

The Driver Definition Wizard presents a list of licensed drivers, select one to all and press the Configure button.

graphics/srvVw14a.png

The Driver Definition dialog will come up with preset values. Modify as appropriate.

graphics/srvVw14b.png

Press the Save button to define the driver.

If the new driver does not apper, check the error log.

If the driver requires any options, you will be prompted to enter these after you click Save once, specify them as appropriate, click Save again to actually define the driver.

When "Show (post-setup) Driver Information" is selected, additional information may be displayed after the driver add operation has completed:

The following table illustrates information about all the drivers Portus supports on Linux and Windows systems

Suggested Driver Name Library Name Suggested SBCS Suggested MBCS Notes / Other Options More Info
Adabas_Driver adabasDriver.so ascii utf16 ListMaxRecords is optional  
Natural_Driver naturalDriver.so ascii utf16   here
AdabasD_Driver AdabasdDriver.so latin1 utf16    
DB2_Driver DB2Driver.so latin1 utf16    
DLL_Driver dllDriver.so ascii utf16    
Echo_Driver echoDriver.so ascii utf16    
Generic_ODBC_ Driver odbcDriver.so latin1 utf16    
Sybase_Driver SybaseDriver.so latin1 utf16    
MS_SQLServer_Driver MSSQLServerDriver.so latin1 utf16    
MySQL_Driver MySQLDriver.so latin1 utf16    
Oracle_Driver OracleDriver.so latin1 utf16    
PostgreSQL_Driver PostgreSQLDriver.so latin1 utf16    
Stored_Procedures_Driver storedProcsDriver.so latin1 utf16    

And the following outlines the driver information for Portus running on mainframe (z/OS or z/VSE) systems

Suggested Name Library Name Suggested SBCS Suggested MBCS Notes / Other Options / Default values More Info
Adabas_Driver ADADRVR CP1141 utf16 ListMaxRecords is optional  
Natural_Driver NATDRVR CP1141 utf16

Natural Batch Pgm : NATBATCH

Init Params : ETID=OFF

Pre-Init Sessions : 2

Max. Sessions: 8

Natural Library Name : SYSSOA

Natural Steplibs: SYSSOAEX,SYSEXT

Natural Security: No

Important:
Natural libraries are required in the Portus server STEPLIB, the Natural Batch Nucleus used MUST NOT be LE-enabled (specify LE370=NO).

here
CICS_Driver CICSDRVR CP1141 utf16

CICS APPLID: specify target CICS system application id

CICS EXCI library is required in the Portus steplib.

 
VSAM_Driver VSAMDRVR CP1141 utf16    
LE_Driver LEDRVR CP1141 utf16

Runtime Options: TRAP(OFF,NOSPIE),RPTOPTS(ON),RPTSTG(ON)

envMax: 50

preEnvInit: 5

 
DLL_Driver DLLDRVR CP1141 utf16    
DB2_Driver DB2DRVR CP1141 utf16    

To remove an existing driver, select the driver, and click Remove

Top of page