Designer Object Methods

Syntax

Connect([in, optional] BSTR startMacro)

Description

This method enables the user to sign on to the PeopleTools application.

Example

‘ Straight Connection
objDesignerCmd.Connect
‘ Connection and run macro
objDesignerCmd.Connect("MacroName")

Description

This method enables the user to sign off from the PeopleTools application.

Example

objDesignerCmd.Disconnect

Description

This method resets the working directory and other environment settings needed for PS/nVision to process reports.

Example

objDesignerCmd.ResetEnvironment

Description

This method causes the designer to register its menu within the grid.

Example

objDesignerCmd.StartMenu

Description

This method refreshes the designer window, including PS/nVision menus.

Example

objDesignerCmd.OnWindow

Syntax

OpenFile([in] BSTR filename, [in, optional] BOOL  updatelinks, [in, optional] BOOL readonly)

Description

This method opens a new or existing PS/nVision report layout.

Parameters

There are three arguments associated with this method: the file name (with full path) and two optional arguments: update links and read-only.

Example

ObjDesignerCmd.OpenFile("c:\user\BALANCE.xls", TRUE, FALSE)

Description

This method opens an existing layout.

Example

objDesignerCmd.OpenLayout

Description

This method creates a new layout.

Example

objDesignerCmd.NewLayout

Description

This method saves the worksheet as a layout.

Example

objDesignerCmd.SaveAsLayout

Description

This method invokes the PeopleSoft nVision Layout Definition dialog box.

Example

objDesignerCmd.DefineLayout

Description

This method invokes the PeopleSoft nVision Layout Options dialog box.

Example

objDesignerCmd.LayoutOptions

Description

This method opens an existing report request.

Example

objDesignerCmd.ReportRequest

Description

This method runs a defined or previously opened report request.

Example

objDesignerCmd.RunCurrent

Syntax

RunReport([in] BSTR BusUnit, [in] BSTR RptRqst)

Description

This method runs a specific report.

Parameters

There are two arguments required for this request: business unit and report request name. The report request must be in uppercase letters.

Example

objDesignerCmd.RunReport("M04", "BALANCE")

Description

This method to opens the PeopleSoft nVision Options dialog box.

Example

objDesignerCmd.Options

Description

This method is same as LayoutOptions with just one selection.

Example

objDesignerCmd.PerfOpts

Description

This method displays the PeopleSoft nVision Open Scope dialog box and then the PeopleSoft nVision Scope Definition dialog box, assuming the user selects a scope.

Example

objDesignerCmd.OpenScope

Description

This method invokes the PeopleSoft nVision Scope Definition dialog box.

Example

objDesignerCmd.ScopeDefn

Description

This method initiates DrillDown sequence.

Example

objDesignerCmd.DrillDown

Description

This method performs a DrillDown using the specified child layout.

Example

objDesignerCmd.DrillLayout

Description

If a default DrillDown layout is defined (as DefaultDrill) in the active instance, drills down using that layout.

For ledger reports, the default drill string may include a D, which indicates that any summary ledgers should be translated to detail. If no default layout is defined, for a query-based instance, drill down to that query in DrillQuery (QueryLink) mode. For a ledger-based instance, have the user select the DrillDown layout, as in DrillDown.

Example

objDesignerCmd.AutoDrill

Description

This method drills the selected cell using the most recently selected DrillDown layout.

Example

objDesignerCmd.ReDrill

Description

This method performs a DrillDown using the specified query.

Example

objDesignerCmd.DrillQuery

Description

This method implements commands to activate the parent instance of the current child DrillDown.

Example

objDesignerCmd.JumpBack

Description

This method runs the specified query with no inherited criteria, and is not used for DrillDown.

Example

objDesignerCmd.RunQuery