page Command

A page is a type of administrative object used to create and manage properties used by server-based apps, such as 3DSpace and 3DDrive. For app properties, all properties load the first time the API is called. At this call, the properties page loads from the classpath (SERVERHOME/managed/properties directory), then loads the properties page installed by any other app that might have altered some property values (such as accelerators), then loads a page object with the exact name as the properties file. That page object only contains properties that the customer specifically changed.

The app first looks for a property file using the classpath, but if the file is not found, it looks for a page object of the same name.

This page discusses:

User Level

Business Administrator

Syntax

The command uses this syntax.

[add|copy|modify|delete|list|print] page NAME {CLAUSE};

  • NAME is the name you assign to the page. Page names must be unique. The name you choose is the name that will be referenced to include this page within a Web page. For more information, see About Administrative Object Names. For pages that store properties for apps, the name but be the same as the property file you are configuring.
  • CLAUSEs provide additional information about the page.

Add Page

As a Business Administrator, you can create new page objects. A page object for a properties file requires content that defines the properties.

Syntax

The are two ways to specify the code for a page.

  • Enter the code as value for the content clause.
  • Write the code in another editor and save the file, then include the name of the file in the file clause.

Use the Add Page command to define a new page:

add page NAME [ADD_ITEM {ADD_ITEM}];
  • NAME is the name you assign to the page.
  • ADD_ITEM provides additional information about the page you are defining.

The ADD_ITEM clauses are:

content VALUE
description VALUE
file FILENAME
icon FILENAME
[!|not] hidden
property NAME [to ADMINTYPE NAME] [value STRING]
history STRING

All clauses are optional for defining a page, since the page can later be modified. For properties to be used, you must include either content or a file.

File Clause

This clause specifies a file that contains the code that constitutes the page. This is provided as an alternative to the Content Clause. With the File clause, you can type and save the code in any editor of your choice.

file FILENAME;

For example, you might create a file called ProgramManCustomProperties.txt that contains updated property values for Project Management. You could create a page object named emxProgramCentral.properties, you can create a text file 

add page emxProgramCentral.properties file ProgramManCustomProperties.txt;

Content Clause

The content clause of the Add Page command is used to add the complete property definitions for an app. 

content VALUE;

  • VALUE can be text. For properties pages, use the same format as in the properties file you are configuring.

For example, you can define the following page to configure a property for Project Management:

add page emxProgramCentral.properties content emxProgramCentral.showRDORoles=FALSE description "Program Management changes for implementation 2017";

As an alternative, you can write the properties to be configured in a separate file and use the File Clause to include the property definitions in the page definition.

History Clause

The history keyword adds a history record marked “custom” to the page that is being added. The STRING argument is a free-text string that allows you to enter some information describing the nature of the addition. For more information, see Adding History to Administrative Objects.

Copy Page

After a page is defined, you can clone the definition with the Copy Page command. This command lets you duplicate defining clauses with the option to change the value of clause arguments.

copy page SRC_NAME DST_NAME [MOD_ITEM {MOD_ITEM}];

  • SRC_NAME is the name of the page definition (source) to copied.
  • DST_NAME is the name of the new definition (destination).
  • MOD_ITEMs are modifications that you can make to the new definition. For more information, see Modify Page.

History Clause

The history keyword adds a history record marked “custom” to the page that is being copied. The STRING argument is a free-text string that allows you to enter some information describing the nature of the copy operation. For more information, see Adding History to Administrative Objects.

Modify Page

Use the Modify Page command to change the definition of an existing page object. This command lets you add or remove defining clauses and change the value of clause arguments.

modify page NAME [MOD_ITEM {MOD_ITEM}];
  • NAME is the name of the page you want to modify.
  • MOD_ITEM is the type of modification you want to make. Each is specified in a Modify Page clause, as listed in the following table.

    You only need to specify fields to be modified.

    Modify Page Clause Specifies
    name NEW_NAME The current page name changes to the new name entered.
    content VALUE The current page content is replaced with new content.
    description VALUE The current description value, if any, is changed to the value entered.
    icon FILENAME The image is changed to the new image in the file specified.
    file FILENAME The page file is changed to the new file specified.
    hidden The hidden option is changed to specify that the object is hidden.
    nothidden The hidden option is changed to specify that the object is not hidden.
    property NAME [to ADMINTYPE NAME] [value STRING] The named property is modified.
    add property NAME [to ADMINTYPE NAME] [value STRING] The named property is added.
    remove property NAME [to ADMINTYPE NAME] [value STRING] The named property is removed.
    history STRING Adds a history record marked "custom" to the page that is being modified. The STRING argument is a free-text string that allows you to enter some information describing the nature of the modification. For more information, see Adding History to Administrative Objects.

As you can see, each modification clause is related to the clauses and arguments that define the page. For example, you would use the Name clause of the Modify Page command to change the name for the page file.

Delete Page

If a page is no longer required, you can delete it using the Delete Page command.

delete page NAME;
  • NAME is the name of the page to be deleted.

This command searches the list of defined pages. If the name is found, that page is deleted. If the name is not found, an error message is displayed. For example, to delete the emxProgramCentral.properties page, enter the following command:

delete page "emxProgramCentral.properties";

After this command is processed, the page is deleted and you receive an MQL prompt for another command.