INTRODUCTION TO ATRIUM... 2 SYSTEM REQUIREMENTS... 2 TECHNICAL DETAILS... 2 LOGGING INTO ATRIUM... 3 SETTINGS... 4 CONTROL PANEL... 4 ADDING GROUPS... 6 APPEARANCE... 7 BANNER URL:... 7 NAVIGATION... 8 EDITING GROUPS... 9 DELETING GROUPS... 9 ADDING USERS TO A GROUP... 10 ADD USER SETTINGS... 11 NAVIGATION PANEL... 12 ADDING NAVIGATION ITEMS... 13 ASSIGNING ICONS... 16 TOOLBAR ITEMS... 16 ADDING A TOOLBAR ITEM... 16 ADDING A BUTTON... 17 AUTHENTICATE CHECKBOX... 17 AUTHENTICATION METHOD... 17 ADDING A NEW PULLDOWN MENU... 18 ADDING A SEPARATOR BAR... 19 GENIE MACROS PANEL... 20 ADDING GENIE MACROS:... 22 ADDING THE GENIE MACRO TO NAVIGATION MENU... 26 OPENS ONCE ONLY... 26 MY SETTINGS... 27 THEMES... 28 ATRIUM S CLIENT-SIDE API... 29
Introduction to Atrium Atrium is an enterprise web portal that ties all of your System i applications into an intuitive and easy to use browser interface. It integrates all of the applications developed with RPGsp, our Rapid Web Development tool, or applications modernized with Genie, our green-screen modernization tool, along with applications created with other Web frameworks. With Atrium, you can finally eliminate clumsy green-screen menus that require you to drill-down through various levels of options just to access the application you need. Instead, you can effortlessly and securely launch the programs that pertain to you from an integrated menu system. Plus, with the portal's tab layout, you save even more time by launching multiple applications simultaneously without having to start a new session or back out of applications that are already open. The portal s interface offers a straightforward navigation system that includes the use of drop-down trees, accordion panels, toolbars, and pull-down menus. It allows system administrators to tailor the interface visually, as well as set up authority-based permissions. The portal provides a secure framework to house all of your web applications and modernized green-screens under a single sign-on tied to either IBM i user profiles or a custom set of user names and passwords. All of the security features native to the IBM i are automatically preserved, while additional administrator functionality further protects the company s applications and data by ensuring that access is only granted to authorized users. System Requirements Atrium requires i5/os (or IBM i) V5R2 or higher. Technical Details During the installation process, Atrium uploads a library named ATRIUM. In addition, it creates and uploads files to an IFS folder named /atrium/. The default library and folder names can be overridden during installation. The installer also creates an HTTP (Apache) Instance named ATRIUM and starts it. The default port used is 480. * The HTTP powered by Apache server is included with the operating system of every iseries/i machine. If successfully configured and started, you will see jobs named ATRIUM running under the QHTTPSVR subsystem. You can use the WRKACTJOB or WRKSBSJOB commands to find them. The manual commands to end and start the server after it is configured are: ENDTCPSVR SERVER(*HTTP) HTTPSVR(ATRIUM) STRTCPSVR SERVER(*HTTP) HTTPSVR(ATRIUM) If the HTTP server is not starting, this may be due to an authority issue. A Profound Logic tech support representative can help you troubleshoot the problem.
Logging into Atrium When the installation completes, you will have the option to launch Atrium. Atrium is a browserbased product, so it will launch in your default browser, such as Internet Explorer or Firefox. If this is your first time launching the product, you will be redirected to the Profound Logic site to activate your copy. You will see a web page that asks you to confirm your system information. After having done this, an activation key will be emailed to you. Once your copy of Atrium is activated, you can launch Atrium again using a desktop icon or by going directly to the Atrium URL. The URL for Atrium is formatted as follows:http://iserieshost:480/atrium/atrium.pgm.
Settings Control Panel The Control Panel can be accessed through the Settings Pull-down menu on the toolbar when first logged in to Atrium. It allows Administrators to customize the portal to fit the needs of different departments in an organization. The Control Panel is an intuitive tab-based interface that includes the following: Users/Groups Panel Navigation Panel Genie Macros Panel
Users/Groups Panel This panel or tab allows for managing users and groups. Using this panel, administrators can: Create, edit and delete users/groups. Manage users/groups Roles. There are 3 different roles in Atrium: o User: By default, a user is granted limited access. o Manager: By default, a manager can create, edit, and delete users within his group. o Administrator: Administrators have unlimited access to Atrium by default. Reassign existing users/groups through a drag-and-drop interface. Customize the look and feel of Atrium to suite different users/groups. Control users/groups rights to customizing/editing their own profile in Atrium.
Adding Groups To add a group, select the All Groups folder as shown in the screenshot below. Next, click Add. The Add Group screen will be displayed as shown below. In the Member of dropdown field, you can select whether this group should be a subgroup of any of the groups that were previously created. By checking the Inherit Settings checkbox, the new group will inherit the settings defined for the group selected in the Member of option. To define the new group s appearance and navigation settings, simply uncheck the Inherit Settings checkbox.
Appearance The settings shown in the screen shot above are the default appearance settings for all new groups. Here, you may change the browser title and banner appearance, and select a new theme if desired. Banner URL: The banner URL property point to where the banner content is located. The URL can be either absolute or fully qualified.
Navigation Navigation settings may be modified with a new title name and width. The navigation type will affect how the options are displayed. Currently, there are two options for navigation type: Tree-style navigation Accordion-style navigation Once your group settings have been selected, click the Save button in the lower right hand corner of the screen. Your new group will be displayed as shown below. For the purpose of these instructions, our new group has been named Development. In the next few sections we will work with this group for editing and adding users.
Editing Groups To edit a group, first start by selecting the group to be modified. Next, click Edit. The Edit Group settings will be displayed and you can make any necessary changes. When finished, click Save in the bottom right corner of the screen. Deleting Groups To delete a group, select the group and click the Delete button in the Groups navigation panel.
Adding Users to a Group Select the group to which you will add your users in the Groups navigation panel. The users with permissions granted for this group will be displayed in the Users panel. Next, we will click the add button in the users panel to add a new user to the Development group.
Add user settings Fill in the user name and the level of access that the user will have. Additionally, by checking the Can edit profile box, the user will have access to change the appearance and navigation settings of Atrium. Indicate whether the profile is an IBM i profile or a user-define profile. If the IBM i Profile, the user will login with his/her regular System i credentials. If not checked, however, the user s login credentials will be stored in a DB2 file. Click save when form is complete. To edit or delete a user, select the user and click the appropriate button in the user s panel.
Navigation Panel This panel or tab allows for configuring a menu system to access modernized green-screens or standard web applications along with managing different navigation styles. Using this panel, administrators can: Create, edit and delete menu items/groups. Reassign existing menu items/groups through a drag-and-drop interface. Control how applications should be launched. Control what type of application should be launched. o Modernized green-screens web-enabled by Genie. o 3rd Party Applications, websites or other web applications. Manage authentication methods to applications. Control users/groups access permissions to web applications or modernized greenscreens.
Adding Navigation Items By default, the navigation panel will appear as shown above. A new menu group has been added by default. To modify this group, simply click the New Menu Group and the group settings will be displayed in the Item Details. Change the Item Name as desired and click update. The revised menu will display in the Navigation Items panel as shown below. To add a new menu group, select the Navigation Panel folder and click the Add button. A drop down menu will appear. Here, select New Menu Group. Designate the new menu group settings for each new group as described above. To add a new menu item, select the menu group and click the add button. A drop down will display two options, New Menu Group and New Menu Item. Select the desired option. Your navigation panel will appear similar to the screen shot below. In this screen shot, we have added a new menu group named Deployment as well as a new menu group and item.
We ll modify a new menu item by selecting the New Menu Item within the Testing group options. The menu item details will be displayed. You may update the item name and action type here. You may also add a url, select how you would like the application to open and assign an icon to the item. After completing the item details, click update. You ll notice that the application name has been updated in the navigation panel to display the name assigned in the Item Details.
Next we ll select New Menu Group. The menu group item details will be displayed. Update the item name, specify an item icon and click update. To assign users to Testing Team One we ll select the group then click the Add button in the Permissions panel. A list of the users and groups that have previously been created will appear. You may double click the user or group that you would like to allow permissions to the specified group or highlight the user and click the Select button at the top of the page.
Assigning Icons The Icon property sets an icon file to be used for the navigation or toolbar item. The icon file can ben in GIF, JPG, or PNG format. Transparent GIFs are recommended, however. The path should be given as an absolute path from the root of the Atrium installation. If no icon is specified, Atrium will use a default icon for navigation items. No icon will be shown for toolbar items unless specified here. Note: This property is optional. Toolbar Items Adding a Toolbar Item The Toolbar Items panel is displayed on the Navigation tab directly below the Navigation Items panel. To add an item to the toolbar, select the toolbar folder and click add.
Adding a Button To add a button to the toolbar, select the Button option in the Add dropdown list. The Button Item Details will be displayed. Update the button name, action type and other fields as desired and click Update. Authenticate Checkbox When authentication is enabled, Atrium will attempt to sign the user into the Web application by sending along the credentials when the item is launched. SSL should be configured when authentication is used so that the credentials are encrypted when sent over the network. Authentication Method There are 2 different authentication methods in Atrium: Request Parameter Request sign on credentials from DB2 database files and pass them along to the web application as encoded parameters. This sign on method is appropriate for user-defined profiles or when setting up System i profiles for all users is not desirable. Profound Logic also offers APIs with Atrium that helps in decoding the sign on credentials and validating them against the database files. HTTP Basic: Sign on credentials are provided by the system s configured HTTP Apache web server instance. This sign on method is appropriate when the web server has been configured to validate users against IBM i user profiles or a validation list.
Adding a New Pulldown Menu To add a pulldown menu to the toolbar, select the Pulldown Menu option in the Add dropdown list. Update the item name and various fields as desired and click update. You may add pulldown items to the new menu as well. In this example, we ve named our new Pulldown Menu Development Team and added two items to the menu. You ll also notice that we ve assigned the development user group to the new menu in the screenshot below.
Adding a Separator Bar To add a separator bar to the toolbar first select the Toolbar folder and click the add button. Select the Separator Bar option in the dropdown list. The new separator will be displayed in the list of Toolbar Items. You may select the separator and drag to the desired location to add a line of separation between two items. Exit the control panel by clicking the X in the upper right hand corner. All of the items we ve covered in the previous instructions are shown. You ll notice the separator bar has been placed between My Company and Development Team as we specified in the toolbar settings. Follow the same steps (listed above) to add a spacer or fill item to your toolbar. A spacer item, as the name suggests, adds a space between two items. A fill item fills the toolbar with spaces until it reaches the very end. A fill item is appropriate when rendering items on both, left most and right most, sides of the toolbar is desired.
Genie Macros Panel Modernized green-screens web enabled with Genie, Profound Logic s on-the-fly modernization solution, can also integrate seamlessly into Atrium s menu and security system. This can be accomplished using Genie macros. Genie macros are flexible scripts that allow developers to: Automatically detect and discover system s green-screens. Automatically sign the user into Genie. Navigate to a certain System i menu or screen. Navigate to a certain URL. Automate keystrokes, etc. It is highly common that users of green-screen applications will have to drill-down through 3 or 4 levels of menu panels to get to the options they want. In Atrium, you can create a menu option that will automatically take the steps needed to bring up the application, so users simply click on a menu link or button to launch the application directly. Using these reusable macros, administrators can change the way users navigate to System i applications, without the need to modify the underlying programs.
The Genie Macros Panel consists of 3 subpanels (see screenshot below): Screens Panel (top left panel): The screens panel is used for screen detection and recognition. You can set up reusable screen definitions, which tell Genie how to recognize certain screens by looking for specific text at specific positions (row, column). Macros Panel (bottom left panel): The macros panel is used for managing macros (i.e adding/deleting macros). Center Panel: The Center Panel is used for managing screens along with their identifiers and macro actions to take when specific screens are detected.
Adding Genie Macros: To add a new macro, you need to set up a screen definition first. Let s say your macro is going to detect the System s Sign On screen, automatically sign the user in, detect the Display Program Messages screen and then launch a program. In the Screens Panel, Click the Add button on the toolbar as shown below. Next you ll be prompted to type in the screen name in the Add Screen Dialog. Type in Sign On and click Add. As you can see from the screenshot below, your screen name has been added as a child of the screens tree. Next, you need to add some screen identifiers. To do so, click the Center Panel s Add button on the toolbar to show the Add Screen Identifier Dialog (shown below). Type in the positions (row, column) and text you wish to detect on the screen and then click Add.
When finished, the Center Panel should now look like the screenshot below. Now, you need to add the macro. Click on the Add button on the Macro Panel s toolbar. You ll be prompted to enter your macro name in a dialog similar to the one shown before in the Add Screen dialog.
After creating the macro definition, you need to define what series of actions to take on the screens defined previously. For example, adding text into an input field, pressing the Enter key, etc. The actions are defined in a non-technical way and can be easily read in plain English as shown below. Following the actions in the screenshot at a higher level, you can gather that the macro (1) detects the Sign On screen once, (2) automatically logs in the user using Atrium s sign on credentials, (3) bypasses the Display Program Messages screen if detected, (4) then launches a program defined in a variable called Program Name (5) and then finally closes the current tab when the sign on screen is detected again. Now, let s go through the process of creating the actions specified in the screenshot above when a particular screen is detected. We ll need to start by adding the Sign On screen. To do so, click the Add Screen button on the Actions toolbar. You will then be presented with a dialog to select any of the screens defined previously. Select the Sign On screen from the drop down field and be sure to check the Detect Once option. This option takes certain actions only once the screen is detected for the first time. Then a different set of actions can be taken if that same screen is detected another time. Now that you have added the Sign On screen, you need to specify the actions to take once it is detected for the first time.
Click the Add Action button on the Actions toolbar. A dialog should pop-up in which a predefined set of actions can be performed. Select the Write a value into a field option from the Actions drop down field. Enter the username field s position in the row and column text fields as shown below. Then, in the Data Type field, select The Current user Profile option to use Atrium s current sign on credentials to sign in to Genie. Repeat this process for the password field and be sure to add the proper position of the field in addition to selecting The current user s password from the dropdown. To launch a program upon sign on, repeat the process described above. However, in this case, you need to select A variable value from the Data Type drop down field. In the Actions data text field, type in: Program Name. One final task; simulate hitting the Enter key on the keyboard. In this case, click the Add Action button on the Actions toolbar and select the Press a key option from the Action dropdown field. Then select A literal value from the Data Type dropdown. Lastly, in the Action data text box, type in: ENTER.
Adding the Genie Macro to Navigation Menu Refer to Adding Navigation Items. The same set of steps can be followed as shown previously in the Adding Navigation Items section, except for a few minor exceptions. First, you need to select Genie Macro from the Action Type dropdown field. Then, select the macro name (Launch Program) created in the previous section. Next, you need to point to the location where Genie is installed by typing in the Genie URL. Last, type the Program Name to launch. The Program Name field was created as part of the variable that we specified while creating the macro. Opens once only By default, when the user launches an item and a tab when this item is already open in the portal, a new tab will automatically appear. There is no limitation on the number of tabs the user can open in this way. However, when the Opens once only option is checked, the user will not be able to open more than one tab for this item. If there is already a tab open for the item when the user selects it, the existing tab will be activated. This option is ignored when opening the item in a new browser window or tab. Click Update to save the changes. The item name (Sales Summary) should now appear in the Navigation Panel.
My Settings Atrium users can further customize the interface if they have been granted the proper privileges. The My Settings option will appear under the Settings dropdown field when users first logon only if they have been granted the authority to edit their own profile. Settings include the overall appearance of Atrium, such as: changing Atrium s theme, controlling the banner html file, banner dimensions and whether Atrium should have a banner. Other options control navigation styles, such as tree-based navigation vs. accordion-based navigation and single-click vs. double-click navigation. By default, Administrator accounts can edit their own profile.
Themes By default, the theme for your portal is set to Light Blue. You may change this option by selecting a different theme from the settings menu on your home page.
In the example below, the Slate theme has been selected. Atrium s Client-side API Atrium.launchURL(url, title, closable) This function launches a page as a tab in the portal. You can use this from your RPGsp programs to launch other programs in portal tabs. This is useful in those cases where you want to create applications that take advantage of the tab-style navigation provided by Atrium, but want to control displaying the tabs programmatically, rather than having the user select it from the menu. Parameters: url: a string representing the url to launch as a tab in the portal. title: a string that becomes the tab label or title. closable: a boolean true or false value. When set to false, the close icon x will not appear on the tab, preventing the user from closing it. Returns: a reference to the tab object being launched Atrium.closeTab([tab]) You can call this function from a page that is running in a portal tab to programmatically close down the tab in the portal. Optional Parameters: tab: a reference to the tab to close. If not passed, the current active tab is closed.
Atrium.launchItem(itemId) This function launches a given navigation item as a tab in the portal. The item will launch using the settings that have been configured for it in the Add/Update navigation item form. Parameters: itemid: a numeric value that represents the unique identifier for the item this value is displayed on the add/update navigation item form. Returns: a reference to the tab object being launched Atrium.activateTab(tab) This function activates a specific tab in the portal given the tab reference. Parameters: tab: a reference to the tab object to activate. Atrium.closeAllTabs ([keephomepage]) This function closes all opened tabs in Atrium, except for the current active tab. You can also call this function to close all tabs except for the homepage tab. Optional Parameters: keephomepage: a boolean true or false value. When set to false, all tabs will be closed. Conversely, when set to true, all opened tabs will be closed except for the homepage tab. If not passed, all tabs will be closed keeping the homepage tab opened. Atrium.getCurrentTab () This function gets the current active tab in Atrium. Returns: a reference to the current active tab object