Write Web Page

Opalis Integration Server > Foundation Objects > Utilities > Write Web Page

Write Web Page

The Write Web Page object will create or add information to an HTML file. When creating new web pages with the Write Web Page object, you can use templates that can contain any of the formatting that you require.

When using the Write Web Page object to create web pages, all occurrences of the tags <DOC-TITLE> and <DOC-TEXT> will be replaced by the title and text that you specify, respectively.

When using the Write Web Page object to append to an existing web page, you will specify an HTML tag that will mark the position where the page will be appended. The Write Web Page object will append the text ABOVE the HTML tag that you have specified.

How it is used

The Write Web Page object can be used to output the entire audit log of a Policy that was run to correct a problem on the network. You can also use the Write Web Page object to keep a constant update of what maintenance Policies are running and their status.

Configuration

When configuring the Write Web Page object you need to choose the action that you are taking on the HTML file and then configure the Details tab.

To select the web page action:

1.

Open the Write Web Page object for editing.

2.

Click the General tab.

3.

Select the Type that matches the action that you want to take:

•

Create Web Page - see details below.

•

Append to Web Page - see details below.

Create Web Page - Details Tab

Title

Type the title of the web page. If you are using a template, this value will replace <DOC-TITLE> anywhere it appears in the template file. If you are not using a template, this value will be used within the <TITLE> tag in the header of the HTML file.

Text

Type the text of the web page. If you are using a template, this value will replace <DOC-TEXT> anywhere it appears in the template file. If you are not using a template, this value will be used within the <BODY> tag in the header of the HTML file.

Template

Type the path and file name of the template file that you are using. You can also use the ellipsis (...) button to browse for the file.

Folder

Type the path of the folder where you want the web page to be created.

File name

Select to specify the file name of the web page that will be created.

Create a file with a unique name

Select to automatically generate a unique name for the web page when it is created. This file will have the extension '.html'.

Append to Web Page - Details Tab

Tag

Type the tag that will mark the point where the page will be appended. It is recommended to use the default tag <OP4-TAG-APPEND-WEB>.

Text

Type the text that will be appended to the web page.

Web page

Type the path and file name of the web page file that you are appending. You can also use the ellipsis (...) button to browse for the file.

Available Published Data

Name

Description

Full path and name of Web Page

The full path of the HTML file that was created or appended.

Source text of the web page created

The text contained within the HTML file.

Title to add to the created web page

The title that was added to the web page. This Published Data is only available when Create Web Page is selected on the General tab.

Text to add to the web page

The text that was added to the web page. This value is determined by the Text field in both the Create Web Page and Append to Web Page modes.

Common Published Data

Title	Type the title of the web page. If you are using a template, this value will replace <DOC-TITLE> anywhere it appears in the template file. If you are not using a template, this value will be used within the <TITLE> tag in the header of the HTML file.
Text	Type the text of the web page. If you are using a template, this value will replace <DOC-TEXT> anywhere it appears in the template file. If you are not using a template, this value will be used within the <BODY> tag in the header of the HTML file.
Template	Type the path and file name of the template file that you are using. You can also use the ellipsis (...) button to browse for the file.
Folder	Type the path of the folder where you want the web page to be created.
File name	Select to specify the file name of the web page that will be created.
Create a file with a unique name	Select to automatically generate a unique name for the web page when it is created. This file will have the extension '.html'.

Tag	Type the tag that will mark the point where the page will be appended. It is recommended to use the default tag <OP4-TAG-APPEND-WEB>.
Text	Type the text that will be appended to the web page.
Web page	Type the path and file name of the web page file that you are appending. You can also use the ellipsis (...) button to browse for the file.

Name	Description
Full path and name of Web Page	The full path of the HTML file that was created or appended.
Source text of the web page created	The text contained within the HTML file.
Title to add to the created web page	The title that was added to the web page. This Published Data is only available when Create Web Page is selected on the General tab.
Text to add to the web page	The text that was added to the web page. This value is determined by the Text field in both the Create Web Page and Append to Web Page modes.