Previous Topic

Next Topic

Book Contents

PFAdmin commands

Note: Any arguments containing commas, equal signs, or spaces must be enclosed within double quotes.

Command

Purpose and Syntax

CHECKREG [/Del] [/DelAll]

Displays the current InForm Server COM and MTS components in the NT registry.

WARNING: Be careful to remove the server(s) or uninstall the service before using either of the delete options:

  • [/Del]—Removes obsolete settings.
  • [/DelAll]—Removes the settings of all servers.

CONFIG Service
[DBServer|
[/AdminDSN DsnName|
[/PfUser ] |
[/SysDBA

Configures an existing service.

  • [/AdminDSN DsnName ]—Creates the ODBC DSN InForm software with the default database server, using the specified user name and password.
  • [/PfUser ]—Creates the PfUser_computername account during the InForm software installation. The account is for Microsoft MTS packages used by InForm servers. In general, you do not need to configure the account. If you change the password through NT User Manager, you must reconfigure the InForm Service with the new password.
  • [/SysDBA ]—Sets the InForm Service DBA user name and password. You can use this command to change the pfdbadmin password as needed.

    If you want to change the InForm Service DBA name, modify the provided SQL script InFormPrepORA.sql with the new user name and password, then run the script as SYS. After running the script, use this command option to configure the InForm Service to use the new InForm Service DBA.

CONFIG Server ServerName
[Automatic|Manual]

Configures the startup mode for an existing server as either Automatic or Manual.

CONFIG Trial TrialName
[Automatic | Manual] |
[/TriDSN DSN] |
[/RndDSN DSN] |
[/Rnd [MDBFilePath ]] |
[/Host ServerName] |

Configures an existing trial.

  • [Automatic | Manual]—Configures the trial startup mode.
  • [/TriDSN DSN —Configures the trial ODBC DSN.
  • [/RndDSN DSN]—Configures the trial randomization source dataset name.
  • [/Rnd [MDBFilePath]]—Creates a trial randomization source dataset name to use the given Microsoft Access database file.
  • [/Host ServerName]—Moves the trial from current host server to another server in the InForm Service.

CONFIG CDD TrialName
[Enable | Disable] |
[DSN [Active | Inactive]] |
[DSN ]

Configures an existing CDD:

  • [Enable | Disable]—Enables or disables the CDD for a particular trial.
  • [DSN [Active | Inactive]]—Makes a CDD DSN active or inactive for a particular trial.
  • [DSN ]—Configures an existing CDD DSN with the User ID and password specified.

HELP

Lists all the options of the pfdamin command.

INSTALL

Creates PfUser_computername and other settings, and installs the MTS library package InFormTrial.

The InForm service does not have to be running for the command to work.

KILLSERVER ServerName

Stops server MTS packages without stopping trials on the server.

PING MachineName
1 | 2 | 3:ServerName | 4:ServerName | 5:ServerName [Port#]

Pings the InForm Service or a particular server. The ping levels are:

  • 1—Ping the InForm Service.
  • 2—Ping the InForm Service and all InForm server(s).
  • 3—Ping the specified server.
  • 4—Ping and get information about the specified server.
  • 5—Ping the specified server and dump the user session to a server-side file.
  • [Port#]—Allows you to specify the port number the echo server is listening on, if you changed it.

REMOVE
[Server ServerName] |
[Trial TrialName [/DSN]] |
[CDD TrialName [/All | DSN]]

Removes an existing server, trial, or CDD.

  • [Server ServerName]—Removes an InForm server from the InForm Service. Trials should be either reconfigured to other servers or removed before this command is run.
  • [Trial TrialName [/DSN]]—Deletes the named trial from the InForm Service. The Web virtual directories and folders for the trial are physically removed. Use the /DSN option to remove the trial-related DSNs.
  • [CDD TrialName [/All | DSN]—Removes either all CDD DSNs in the specified trial or the given CDD by DSN.

Note: Before using the PFADMIN REMOVE command, verify that IIS is running.

[RULESCANVIEW |
RULESCANPEOCESS]
TrialName

  • RULESCANVIEW—Scans existing rules and execution plans, and outputs a list of rules that violate the allowed rule objects list
  • RULESCANPROCESS—This command executes the same validation process that occurs during trial start. It marks rules as valid or invalid.

SETSERVER
[Site TrialName ComputerName] |
[MedMLInstaller TrialName ComputerName] |
SYSTEMPW TrialName

Changes the MedML and Site servers.

  • [Site TrialName ComputerName]
  • [MedMLInstaller TrialName ComputerName]
  • SYSTEMPW—Activate and set or change the password for the InForm system user.

Note: Before using SETSERVER MedMLInstaller, put the trial in design mode. To do this, use the pfadmin start trial /design command.

Note: The SETSERVER command requires that you set the Default Authentication Level property of the InForm server to Connect:

To set this property:

  • Select Administrative Tools > Component Services > My Computer - Properties.
  • Set the Default distributed COM communication properties value to Connect.

SETUP Server ServerName [Automatic]

Creates a new InForm server in the InForm Service.

  • [Automatic]—The server is automatically started with the InForm Service. Manual startup is the default.

SETUP Trial TrialName ServerName
[/DB OracleConnStr] |
[/DSN TriDSN [Automatic]]

Creates a trial on the given InForm server with the option to either create a new or use an existing ODBC DSN. The server has to be created. The trial startup mode is Manual by default. The mode can be configured in automatic with the option Automatic. A trial with the automatic startup mode is started automatically when the InForm server that hosts the trial is started.

  • [/DB OracleConnStr ]—Creates an ODBC DSN TrialName with the given ServerName.
  • [/DSN TriDSN [Automatic]]—Configures the created trial TrialName to use the given trial dataset name TriDSN The trial must be present in the ODBC DSN.

Note: Before using the /DSN command, verify that IIS is running.

SETUP CDD RefName TrialName
/DB OracleConnStr DSN
[/TBSP OraTBSP] [Active] [NoSchema]

Sets up a new CDD DSN associated with the given CDD refname.

  • [/TBSP OraTBSP]—Defines the Oracle tablespace for the CDD schema.
  • [Active]—Specifies that the DSN is transactional.
  • [NoSchema]—Indicates that no new CDD schema should be created during setup. The existing database is not touched. By default, the user is dropped and the Oracle database destroyed. Then, a new schema is created and populated based on the RefName that defines the schema.

Note: To execute this command successfully, the trial must be started.

SETUP CDD RefName TrialName
/DSN DSN
[/TBSP OraTBSP] [Active] [NoSchema]

Sets up an existing DSN associated with the given CDD RefName.

  • [/TBSP OraTBSP]—Defines the Oracle tablespace for the CDD schema.
  • [Active]—Makes the DSN transactional.
  • [NoSchema]—Indicates that no new CDD schema should be created during setup. The existing database is not touched. By default, the user is dropped and the Oracle database destroyed. Then, a new schema is created and populated based on the RefName that defines the schema.

    Note: To execute this command successfully, the trial must be started.

START
[Server ServerName] |
[Trial TrialName]

Starts an existing InForm server or trial.

  • [Server ServerName]—Starts an existing InForm server by server name.
  • [Trial TrialName]—Starts an existing trial by trial name.

START
[Trial TrialName [/Design]]

Starts the trial in design mode. This means you can install trial components that are not completely designed (strict checking is not in force). By default, the trial starts in production mode.

STOP
[Server ServerName [/Trials]] |
[Trial TrialName [/Anyway]]

Stops an existing InForm server or trial.

  • [Server ServerName [/Trials]]—Stops an existing InForm server by server name. By default, a running server can be stopped if there is no trial running and no other application connected to it. The Trials keyword stops all running trials, and then stops the server.
  • [Trial TrialName [/Anyway]]—Stops the named trial. The Anyway keyword stops a trial regardless of any connections or HTTP requests.

UNINSTALL

Removes all InForm servers and trials, and then removes the InForm service settings PfUser_computername and the MTS library package.

Note: The InForm service must be running for the command to work.

UPGRADEENV TrialName

Upgrade InForm environment settings for the pfUSR account.

VIEW
[Service] |
[Server ServerName] |
[Trial TrialName] |
[CDD TrialName]

Displays a monitoring list of all servers in the InForm service, all trials in servers, or all RefNames for CDD DSNs configured for a trial.

  • [Service]—Lists all the servers and trials in the InForm service.
  • [Server ServerName]—Lists each server by server name and trials hosted on that server.
  • [Trial TrialName]—Lists a trial by its name.
  • [CDD TrialName]—Lists the RefNames for each CDD DSN configured for the specified trial.

Command line prompts

Depending on the options you specify, you are prompted for the following parameters:

For pfadmin setup or pfadmin config commands:

For pfadmin setserver commands:

Use alphabetic or alphanumeric characters for the UID and PID, and begin them with a letter; do not use all numeric characters.

Send Feedback