- RoboHelp samples

Some default components used for cut and paste.

All topic names and filenames must be in proper case. For example, 'Setting up Lexicon Population'.
Main PROIV workspace is called a screen
Smaller screens called from the larger workspace are called windows
Screens requiring a response from the user are called message boxes.

H2 and Title variable - add to all topics

Section links:

Client Management ActiveX Control Flowcharts contains flowcharts which provide graphical overviews of how the ActiveX control works.

Client Management Active Control Properties contains details of the control's properties.

Client Management ActiveX Control Events contains details of the control's events.

Screenshot drop-down hotspot example

Click here to see an example screenshot of the Maintain Control Bar Definition window.

Procedural Example

To define Server-Side Object's initial property values which are used when the function creates the SSO, follow these steps:

Open the relevant function.
Click Function Definition Properties icon and click on the SSOs tab.
Click Properties . The is only enabled if the selected SSO has associated properties.
The Properties for SSO window appears.
Select the property that you want to configure and click the Assign . The Assign value to property window appears.
Enter the appropriate value and click the OK to close the window.

Item

Description

Field with conditions

e.g. ClientBackColor

Example text -

'Sets the background colour of the PROIV session if the following conditions are true:

If the DefaultWallpaper has not been defined.
If the DefaultWallpaper has not been loaded into the PROIV Client

Field with settings -

e.g. Alignment

Example text-

'Select the text alignment of the headings independently of the column alignment and on a per column basis. The settings are as follows:

Centre - Sets the alignment to the centre of the column header.

Left - Sets the alignment to the left of the column header.

Right - Sets the alignment to the right of the column header.

Default - Sets alignment to mirror the alignment configured for the rest of the column.'

Field requiring user entry -

e.g. Max Length

Example text - 'Enter the maximum length of the translated text.'

Display only fields -

e.g. Licence Expiry time

Example text -'Displays the licence expiry details, including the date, day and time.'

Buttons -

e.g. OK

Example text - 'Click Close to close the window.'

Check boxes -

e.g. Username

Example text - 'Select the check box to ensure that the user name and password details are remembered. Click here for more information about the enhanced Open Client Paging Area'.

Error Messages

Note:

Warning

Idea

Documentation

Item	Description

Default	Minimum	Maximum
32	10	72

Fields	Description
Service ID	Enter a name for the data feed. This name is then available for selection in the Feed Service section on the Maintain Components screens and in JavaScript. A10-Mandatory
Service URL	Enter the URL of the service that is to be used by the component. For example, you can enter a RSS Data Feed in this field. For instance, http://feeds.bbci.co.uk/news/england/rss.xml sets the service of the component to the BBC UK news feed. Parameters can be placed in the URL by the component with the use of placeholders. In the component you have an array of parameters, the position in the array relates to the placeholder http://example/rss?param1={0}&param2={1} A250-Mandatory
Service Username	If the Service URL requires an authenticated logon, enter the user name in the Service Username field. A50-Non-Mandatory
Password	If the Service URL requires an authenticated logon, enter the password in the Password field. A50-Non-Mandatory
Service Function	If the component is to be driven by PROIV Data Feed, enter the name of the PROIV Report function, which generates RSS XML. A32-Non-Mandatory
Proxy	Drop-down list displays available proxy server details. Select one from the list if a proxy is used to access the service. Non-mandatory
Requires Company /Division	Select the check box to append the Operators ID to the Service URL. The parameter allows a service to return data specific to a company or operator. For example, graph data showing sales for a company/department could use the Co/Div parameter to limit the data accordingly. For example, if the check box is selected for a single Co/Div logon, the append format is as follows: http://feeds.bbc.co.uk/news/englandrss.xml?coDiv=PTI&multiCoDivEnabled=N
Requires Operator ID?	If the service being called by the component is PROIV Operator dependent, enable the Require Operator Id? field. The ID is then passed into the service URL as a parameter and will limit the component appropriately, depending on the operator’s privileges. The Operator ID is placed into the first placeholder. For example, if the Operator ID is 'aurora1' then selecting Operator ID check box appends pid=aurora1 to the Service URL, so in this case it becomes: http://feeds.bbc.co.uk/news/englandrss.xml?pid=aurora1
Buttons
Exit	Click Exit to close the Maintain Data Feeds screen.
Save	Click Save to save the changes to the Data Feeds.
Cancel	Click Cancel to cancel any changes to the Data Feed.
New	Click New to add a new Data Feed.
Delete	Click Delete to delete the selected Data Feed.

Comment on this topic

Topic ID: 010005