Viewing and Defining Metadata and Details
View and define layout metadata and details in the top portion of the Layout Designer – Layout page.
The Layout Details section is collapsed on the page by default. Click the arrow button to expand the section.
The table lists the metadata fields and controls that appear on the Layout Designer – Layout page:
Field or Control |
Definition |
---|---|
Layout Name |
Displays the name of the layout. |
Type |
Displays the type of layout. Currently, Mobile is the only supported layout type. |
Title |
Enter the title of the application as you wish it to appear in the browser title bar. This value defaults to the layout name. |
Initialization |
Click the link to access the Initialization page to set the following:
|
View Initialization URL |
Click the link to display the URL for the mobile application that you are developing. Copy the URL and paste it in the browser URL field to view and test the application. |
This table lists the fields and controls that appear in the Layout Details section of the Layout Designer – Layout page:
Field or Control |
Definition |
---|---|
Package |
Displays the package name that contains the PeopleSoft document linked to the layout. |
Document |
Displays the name of the PeopleSoft document linked to the layout. |
Version |
Displays the version of the PeopleSoft document linked to the layout. |
Description |
Enter a description of the layout. |
Details |
Enter a more lengthy description of the layout. |
Service |
Displays the name of the system-generated REST service for the layout. |
Related Actions |
Click the link to access the Related Actions page to override the default Class, Style, Popup Class and Image to use for defined Related Actions on the MAP application. |
Group |
Enter a group name to group layouts together. Layout search pages can search by group name to show a logical grouping of layouts. |
Owner ID |
From the drop-down list, select an owner for the layout. |
Validation |
From the drop-down list select the type of data input validation for the layout. The options are:
Access the JavaScript validation file in the application HTML source:
Or navigate to the following path to access the validation file:
Note that depending on where you configured the integration gateway, the base folder could be a different location than the current PIA_HOME. |
Raphael |
Select the box to add links to the application HTML source for Raphael JavaScript libraries for charting. |
Document Dump |
Select the box to generate in JSON the PeopleSoft document linked to the layout. The system adds the JSON to the header in the application source HTML as a variable. |
Bookmark |
Select the box to add Google JavaScript links to the application HTML source to create bookmarks. |
Retain State |
Select the box to save the state of the PeopleSoft document data on the initialization event. |
Touch Image |
If you are implementing an application for the Apple framework, select an image for the tile. |
Exception Layout Name |
Enter the Exception Layout Name. An exception layout is simply another layout. If an exception occurs the MAP framework will invoke the defined Exception Layout. The developer can get access to the exception information thrown via People Code. |
Exception Layout
An exception layout is created the same as any other MAP layout. When an exception occurs in the MAP application, the OnInit event for the exception layout is invoked The methods/ properties available are the same for the standard Exception Object.
This is an example of code for the OnInit event for the exception layout.
&Exception = &Map.MAPException;
To get the Layout name that actually threw the exception:
&Map.ExceptionLayoutName;
To retrieve the Document information at the time of the thrown exception:
&ExceptionDocument = &Map.GetExceptionDocument();
To retrieve the URI Document information at the time of the thrown exception:
&ExceptionURIDocument = &Map.GetExceptionURIDocument();
See Understanding Exception Class
This table summaries how the exception is handled based on the event.
Event |
How exception is handled |
---|---|
Base Event: (OnInit) and Update Event(s) |
Will always invoke the Exception Layout |
Save Event |
Will not invoke the Exception Layout |
AJAX Event |
By default will not invoke the Exception Layout. However, the developer can override this by setting the Use Exception Layout property |
Note: It will be up to the developer to properly handle the HTML that will now be returned to the client as a result of the Exception Layout being thrown.