EasyManage Platform : User Guide

Table Of Contents


 

For EasyManage Platform
(EM WebPlus Suite 5.0 | EM 5.0)

(On Windows & Unix Platforms)

 


User Guide 5.0

 

Includes:

Suite 5.0

Studio 5.0

Collaboration 5.0

Tools Integration SDK 5.0

 

(Updated: 10-Jan-20, Build 05.82 P25.25)

 


 

Contents (Chapters)

 

Introduction. 10

EasyManage Platform (EM WebPlus Suite 5.0). 10

Chapter 1: Before You Begin. 10

Chapter 2: Getting Started. 12

Chapter 3: Solution, Table & Data Designing with EM... 18

EM WebPlus Studio 5.0. 22

Chapter 1: EM Inbox. 22

Chapter 2: EM Objects - Folders, Tables, WebProjects. 25

Chapter 3: EM Tables. 28

Chapter 4: EM WebProjects. 75

Chapter 5: POWER Search (Explorer_PLUS). 83

Chapter 6: Applications. 87

Chapter 7: Options & Settings. 93

Chapter 8: Using Images (Icons, Links) For EM Objects. 110

Chapter 9: Advanced Features. 113

Chapter 10: FAQ’s / How To’s?. 122

Chapter 11: Using Applications. 125

Chapter 12: Portal (Direct Access URLs). 128

Chapter 13: Using Dashboards. 129

Chapter 14: Content (Applications - Content Type). 131

Chapter 15: Search. 133

Chapter 16: Portal Plus Features. 135

EM WebPlus Collaboration 5.0. 135

Chapter 1: EM Mail. 135

Chapter 2: Using Collaboration. 152

Chapter 3: Collaboration Search. 156

Chapter 4: Virtual Wave : EMit (Status Updates), Tagging & TagPlus. 157

EM WebPlus Tools, Integration, SDK 5.0. 167

Chapter 1: Tools - Reports. 168

Chapter 2: Integration Tools. 170

Chapter 3: SDK - Web Services. 172

Appendix A: Administrator Information. 177

Appendix B: General Specifications. 179

Appendix C: Screen List. 180

 

 

 

Chapter Contents

 

 

Introduction 10

EasyManage Platform 10

Chapter 1: Before You Begin 10

Using EM 5.0 10

Developer Pre-Requisites 11

Developer Pre-Requisites for Advanced Options 11

Application Strategy 12

Prototype 12

Pre-Development Tasks 12

Will Use Advanced Features? 12

Chapter 2: Getting Started 12

Connecting to EM 5.0 13

Sign-Up 13

User Id Restrictions: 14

Password Restrictions: 15

EM User Privileges 15

Sign-In 15

Express Sign-In 15

Advanced Sign-In Options 16

Search Links on Sign-In Screen 16

Sign-Out 17

Sign-In Using Third Party Accounts 18

Access Via Mobile Phones, Mobile Devices 18

Chapter 3: Solution, Table & Data Designing with EM 18

Design Pillars (Criteria) 18

Defining your Solution, Application or Product Use 19

EM WebPlus Studio 5.0 22

Chapter 1: EM Inbox 22

What is EM Inbox 22

Inbox Module 22

Default Destination Inbox – Explorer 23

Inbox - Trash, Archives, Application Tree 24

Inbox - My Menu 24

Inbox – User Search 25

Chapter 2: EM Objects - Folders, Tables, WebProjects 25

Creating EM Objects 25

EM Objects – Edit 26

EM Objects – Del 26

EM Objects – Archive 27

EM Objects – Copy 27

EM Objects - Cut[Move] 27

EM Objects – Paste 27

Scope Of Copy & Paste 28

Chapter 3: EM Tables 28

EM FlexiTables 28

EM Tables - Special Table Objects 28

EM Tables – My Table 29

EM Tables – Db Table 29

EM Tables – Db Table DirectAccess 29

Set Minimum Options 30

Table Options – No Fields 30

Define EM Table Fields 30

Import Field Definitions from database Table 31

EM Data Types With MySQL, Oracle, MS SQL Server 31

File  (Document) Type 36

Date Formats 36

Table Options Menu 36

View Fields 38

Edit/Add Fields 39

Copy From (Add Fields) 39

Delete Fields 40

UnDelete Fields 41

EM Unique Keys 41

EM Foreign Keys 42

Table Properties 43

Table Level Properties 44

Field Level Properties 45

Table Join (Data Copy/Update Table-to-Table) 45

Advanced Table Join: Special EM Script 47

Data Options (No Form) 48

Input/Edit Data (No Form) 49

Archive Data 49

UnDelete Data 50

Table Form: Edit 50

Table Form: Edit : Form Properties 52

Table Form: Edit : Form Layout 55

Table Forms: Edit : Field Properties 57

Data Options using Forms 67

Saved Queries 68

New Query: Enter Query Details 69

Simple Queries 69

Using Non-Field Criteria in Query 70

Advanced Queries 71

View All (Data) (Form) 72

File Details 73

Input/Edit Data (Form) 74

XML (Data) (Form) 74

Chapter 4: EM WebProjects 75

Web Screens Workflow - WebProject Menu (EM Inbox) 75

Create New Web Screen 76

Create – Copy From (WebScreen) 77

Edit WebScreen 77

Using different Screen Modes: 80

Using Direct Access URL : 81

Using Send/Receive Parameters: 81

Delete WebScreen 82

WebScreen: Execute in EM Inbox or Direct access via URL 82

Web Screen Workflow : Execute in Application 83

Chapter 5: POWER Search (Explorer_PLUS) 83

POWER Search/ Explorer_PLUS 83

List (500) EM Objects Menu 83

Common Parameters - Check Dates/Sorting 84

Search Folders/Categories/Tables 84

Search Table Fields 85

Search Table Data 85

Search WebProject Screens 86

Chapter 6: Applications 87

Applications Menu 87

Application Register 87

Application Register: Create New, Edit, Delete Screen 88

Application Subscribe 92

Application Subscribe: Create New, Edit, Delete Screen 92

List Apps 93

Multi-App Srh 93

Auth Define/Grant 93

Run Application 93

Chapter 7: Options & Settings 93

Options Menu (In Inbox) 94

Settings Menu (In Inbox) 94

Member Account: Update Registration Data 94

Member Account: Change Password 97

Member Account: Update User Profile 97

International settings (Date/Time Formats,…): 98

GUI/Screen Preferences section: 104

Table and Forms: Default Properties/GLOBAL Updates 106

Utilities 107

Refresh Category Tree 107

Refresh Category Tree (For ODBC type databases) 107

Upload Menu & Images 107

Settings Menu (In App Run) 110

Chapter 8: Using Images (Icons, Links) For EM Objects 110

Introduction 110

Jsp Configuration Parameters For Image Menus 110

Image Links For Application List Menu 112

Image Links For Application Menu (Folders) 112

Image Links For Application (WebProject) Screen Menu 112

Image Links In Frames User Menu 112

Chapter 9: Advanced Features 113

Customizing Jsp Files 113

EM Script Code Processing 113

HTML Tag Restrictions 117

Record Scroll Bar 121

Chapter 10: FAQ’s / How To’s? 122

Fetch Back Multiple Values from Look-Up 122

Implement Master-Detail Input/Edit Screens 122

JavaScript Calculations in Input|Edit<Multi> Modes 123

Advanced Uses of WebScreen CallBean Mode 124

How to use multiple (Ora, Msq, Access) db conn 124

How to invoke specific application after Sign-In 125

How to Trim Menu/Screen Names 125

How to use custom style for HTML 125

Chapter 11: Using Applications 125

List Applications 126

Run Application 126

Run Application: App Explorer, App POWER Search, My Menu 127

Run Application: AppLinks Session All Received 127

Run Application: WebProject Display 128

Chapter 12: Portal (Direct Access URLs) 128

Portal Home 128

Portal Search 128

Chapter 13: Using Dashboards 129

Dashboard 1 129

Frame Levels 129

Dashboard 1 Options and Menus 130

Chapter 14: Content (Applications - Content Type) 131

Managing Content 131

ContentApp (Menu Items in Inbox->Applications) 131

Content App List 132

Content App Search 132

Applications (Content Type, Public Access) 132

Content App Home 132

Content App Search 133

Content App List 133

Chapter 15: Search 133

Search 133

Portal Search 134

Content Search 134

Collaboration Search 134

Multi-App Search 134

POWER Search 134

Search Mail 134

Search Collaborations 134

Latest Activity (Search) 134

Chapter 16: Portal Plus Features 135

Granting Access to Groups 135

Blocking Users 135

EM WebPlus Collaboration 5.0 135

Chapter 1: EM Mail 135

Types Of Mail 136

What is EM Mail ? 136

Mail Box – Menu 137

Compose (Session - All) 137

AppLinks (Session - All) 139

Create Mail (In - Out) 140

View EM Mail List - Inbox (Mail), Outbox, Selected Folder 141

Folders 142

Imported Mail 142

EM Mail Selected (Generic View) 143

EM Mail - View 144

EM Mail - Send 144

EM Mail - Move 145

EM Mail – Delete 146

EM Mail – DeleteFiles 146

EM Mail – Import 146

EM Mail - View Imported 147

EM Mail – CleanUp 148

EM Mail – Copy 148

EM Mail – Refresh 149

EM Mail – RefreshUpdate 149

EM Mail - Create Collaboration 150

Check Mail 150

Search Mail 151

Chapter 2: Using Collaboration 152

Creating A Collaboration 152

Collaboration Application Registration 152

Creating MyCopy Of A Collaboration 153

Collaboration Menu 153

Creating New SubInbox type of Collaboration 154

List My Collabs 154

List Subscribed/Authorized 154

Subscribed/Authorized Collaboration Selected 155

Chapter 3: Collaboration Search 156

Search Shared Spec User 156

Search Shared Auth/Public 156

Collaboration Search 156

Chapter 4: Virtual Wave : EMit (Status Updates), Tagging & TagPlus 157

EMit : Status Updates 157

Tagging & TagPlus 157

How does Tagging work 157

Virtual Wave 159

Some Requirements and Configuration Parameters 159

Tag Menu 161

Create A New Tag 162

View/Edit TagPlus 163

Tagging Configuration 163

Session Settings 166

EM WebPlus Tools, Integration, SDK 5.0 167

Tools Menu 167

Chapter 1: Tools - Reports 168

Reports 168

Report - No Of Categories (Folders/Tables/WebProjects) 169

Report - Tables with Data Records (excluding deleted/archived) 169

Report - Tables with Archived/Deleted Data Records 169

Report - User Id (Account) Privileges Information 169

Report - User Blocked Information 169

For Advanced Users: 169

Report - Table Linked Data Information 169

For Super Users: 169

Report - License Information 169

Report - [All Users] As Selected Below: 169

Report - All Object Ids Current Seq. Values 169

Chapter 2: Integration Tools 170

Bringing Existing Database Objects (Tables) into EM Inbox 170

Import Objects 170

Import Objects 170

Generate Table Integration Scripts (All Tables) 171

EM Inbox Objects migration to Database Objects (Tables) : 172

Generate Table Schema (All Tables) 172

Generate Table Schema 172

Chapter 3: SDK - Web Services 172

Web Services – Menu 173

Naming Guidelines, Conversions and Data Type Mapping 173

Generate (Session - All) 174

Deploying Generated Web Services 176

Runtime Considerations For Deployed Web Services : 176

Appendix A: Administrator Information 177

EM Configuration Parameters (Default / Plan / User) 178

How to use EM Configuration Parameters? 178

How to use Plan or User specific EM Configuration Parameters? 178

Which Parameters can be override via Plan / User files? 178

Appendix B: General Specifications 179

Characters not supported or converted 179

Using HTML Editor 179

Database Specific Features or Feature Restrictions 180

Feature Restrictions Table For MS SQL Server, Oracle, MS Access: 180

Appendix C: Screen List 180

 

 

 

Introduction


This guide describes the Developer and User features of EasyManage Platform, also referred previously as “EM WebPlus Suite 5.0” or “EM 5.0”, for developers, users. It gives information on pre-requisites, Studio features (building applications with EM 5.0) and highlights server, portal and content services features of the product suite.

 

Please note:

  • Reference to previous release is made as EM AFE 4.0 or EM AFE Release 4.0 or EM ApplicationFrame Work Engine 4.0.
  • Studio is also referred as EM AFE or EM Inbox.

 

 

EasyManage Platform (EM WebPlus Suite 5.0 | EM 5.0)

 

EasyManage Platform comprises of all the products for release 5.0 based upon the build and edition.

 

 

Chapter 1: Before You Begin


This chapter highlights the usage pre-requisites and also the methodology and strategy matters needing attention before developing an application.

 

Using EM 5.0


If you are using EM 5.0 for the first time, please read the section below.

 

  • No Client Install: EM 5.0 is browser based environment. No client install required.

 

  • User Pre-Requisites: For application user or developer browser use experience (with Internet Explorer 4.0+) and ability to navigate, fill out forms, submit to web server is all that is required.

 

  • Getting Licensed User Id: EM 5.0 can be used by licensed user ids which are supplied as part of the License or provisions are made to define them in configuration file unless your license allows for no user id license check as in e.g. processor based license.

 

  • Sign-Up: All the users of EM 5.0 should sign-up first using the licensed user ids designated for them. After which they can start using it.

 

 

Developer Pre-Requisites


EM 5.0 is browser based easy to use yet powerful web application development environment. The developer’s should be familiar with following in order to use it at initial to intermediate level:

 

Familiarity with Web Application Development using Forms:

  • Knowledge of browser based application development using forms, field attributes, Menus, form parameters, navigation.
  • Knowledge of HTML tags, SQL query only if you desire to use add-on customization features.
  • Knowledge of JavaScript is required only if you desire to use JavaScript add-ons in EM 5.0.

 

Familiarity with RDBMS:

  • Knowledge of tables, columns, data types, relational operators, SQL queries, search wild chars.
  • Knowledge of primary keys, referential integrity, indexes, SQL tuning, user security and experience with creating tables, writing SQL, manipulating data in tables would be a plus.

 

 

Developer Pre-Requisites for Advanced Options


The developer’s should be experienced with following in order to use EM 5.0 Advanced options:

 

RDBMS:

  • Experience with PL/SQL, functions, procedures, writing advanced SQL, SQL tuning, transactions, etc. is desirable.

 

Web Application Development:

  • Experience with application development for large projects, apps integrated with RDBMS, multiple form parameters, managing multiple forms is desirable.

 

 

Application Strategy


Define your app strategy in terms of what will an application consists of, who will be the application owner, will users belong to different departments or functions needing separate data groups, etc. Please refer to the detailed chapter “Guide to Table & Data Designing for EM WebPlus” for more information.

 

 

Prototype

 

EM 5.0 allows development of applications in incremental fashion. A prototype can be developed rapidly consisting of tables and forms allowing data inputs, edit and display. End users can be involved at prototype stage to increase acceptability of system.

 

 

Pre-Development Tasks


Before you start building application using EM 5.0, it will help to have following documents ready: application design at broad level, preliminary table designs, identifying which are large tables, number of users, amount of data to be stored, etc.

 

 

Will Use Advanced Features?


Decide whether following advanced features will be used in your application:

  • PL/SQL
  • Stored Procedures and functions
  • SQL conditions
  • Modified SQL for display
  • Advanced Table Column Joins
  • My Menu
  • Custom HTML tags
  • JavaScript

 

If yes, notify your EM Administrator/DBA and have his involvement in application development process.

 

 

Chapter 2: Getting Started

 

This chapter helps you getting started with use of EM 5.0 and describes connecting, Sign-up, Sign-in, Sign-out operations through browser on your desktop.

 

Connecting to EM 5.0


To connect to EM 5.0 follow these steps:

 

  • Open a new browser window.
  • Type the URL for connecting to the EM 5.0.
  • Usually this URL is as below (unless changed after install):
  • For Jswdk: “http://127.0.0.1:8000/em”, if accessing from same machine, or “http://<server hostname or I.P. Address>:8000/em”.
  • For Tomcat: Port no is 8080 (instead of 8000).
  • A welcome screen is displayed with form to express Sign-In and options to Go to Advanced Sign-In, Sign-Up, Public Search.

 

Screen Snapshot: EM - Welcome

 

Please refer to Sign-In section for help on using Sign-in form.

 

Notes on browser use:

  • The cookies must be enabled for using EM 5.0.
  • Multiple browser Windows: After Sign-In new window can be opened for multiple accesses from existing EM Inbox links. However if you need to use different User ID or App from new window, then first open the new browser window from desktop or program followed by new sign-in.

 

 

Sign-Up


Now that you are ready to Sign-Up, here are the details you need to enter on Sign-Up Screen.

 

Screen Snapshot: Sign-Up

 

Sign-Up Screen has following information fields and menu options.

 

If the service sign-up requires invitation codes then following message is displayed in the beginning:

 

* Note: Sign-Up to this service requires valid invitation codes. Please request codes to support@easymanage.com. [Code Check Flag: 1]

 

 

 

* indicates field must be entered

 

 

Invitation Code / Auth. Key:

If Sign-Up to this service requires valid invitation codes, they need to be entered.

 

User

User Code

 

Group

Group Code

 

 

 

 

E-mail *

E-mail

 

 

 

 

Display Name *

To be displayed As Name Of User / Network / Group / Application

 

 

 

 

 

 

 

Gender

Gender: Male,Female,” “ (Blank)

 

Date Of Birth /  Establishment:

 

 

Year

Birth Date: Year, nnnn

 

Month

Birth Date: Month

 

Day

Birth Date: Day

 

 

 

 

City

City

 

State   

State   

 

Zip

Zip code

 

Country

Country

 

 

 

 

 

 

 

Please select a User ID and password for your login:

 

 

 

 

 

User ID *

User ID. Must be unique.

See User Id Restrictions below.

 

Password *  

Password for this User ID. Must be 6 chars long.

 

Re-enter Password *

Re-enter the password for verification.

 

 

 

 

Please enter the characters from image *:

Captcha image verification. User must enter the characters displayed in image next to input box.

 

Try Another Image

Button to display another image. If selected new image characters should be entered above.

 

 

 

 

By clicking on Submit below, you are indicating that you have read and agree to the terms and conditions of Licence Agreement and Terms of service and Privacy Policy.

 

 

 

 

 

Submit

 

 

 

User Id Restrictions:

 

  • Minimum 6 characters.
  • Use only letters: [A-Z], [a-z], digits and underscore
  • No other characters allowed.
  • The User ID (in any case, lower, upper or mixed) :
    • Can not begin with: EM, PORTAL, EASY, APP, MAIL, WSGEN, MY_MENU, FILEDATA, DEMO, GUEST, PLATFORM, PAAS, EASYMANAGE;
    • Can not contain: XX

 

Password Restrictions:

 

  • Minimum 6 characters.

 

 

EM User Privileges


EM 5.0 User Ids are classified into different categories. The license given to end-user is for a Named User of a type as given below.

 

O  Developer: Is a Named User having developer privilege for the particular product module along with deployment for self testing.

O  Developer - Advanced: Is a Named User as Developer, plus having   Advanced User privileges such as SQL Extensions and EM Scripts.

O  Application (Owner): Is a Named User having Developer privileges and   application development, maintenance and deployment privileges for access by other users.

O  Self Inbox/App Owner: Is a Named User having Inbox privilege to develop and use a self application module but excludes application  deployment privileges for access by other users.

O  User (Application User): Is a Named User having application use privileges only but no Inbox (developer) privileges.

O  Portal Owner: Is a Named User having privilege to develop a application portal, maintain it and deploy the portlets for access by other users.

O  Content Owner: Is a Named User having privilege to develop content services, maintain and deploy them for access by other users.

 

The privileges granted to the Named Users are derived internally from User Id granted with one or more of privilege roles or setting user properties. The privilege roles are: Authorized User or App Only User. Authorized user can have additional privileges such as Inbox owner, Application Owner, Advanced User.

 

Depending upon the user id privileges specific screens will be available or unavailable to you after you sign-in to EM 5.0.

 

 

Sign-In


Use the sign-in form on Welcome screen or Advanced Sign-In screen to get entry into EM 5.0, depending upon the user id privileges different screens will be available after sign-ins.

 

Express Sign-In

 

Screen Snapshot: See EM Welcome screen above.

 

Sign-In form has following information fields and menu options.

 

 

User ID

User ID.

 

Password  

Password for this User ID.

 

Express Sign-In uses following default values for following other fields not shown on form:

 

Dashboard

 

 

Destination

Defaults to: Inbox

 

Login As

 

 

Data Grp

 

 

First Screen 

Defaults to: Default

 

 

 

Advanced Sign-In Options

 

Screen Snapshot: Advanced Sign-In Options

 

Sign-In Screen has following information fields and menu options.

 

 

User ID

User ID.

 

Password  

Password for this User ID.

 

Dashboard

Select One of available Dashboards.

Blank = None

 

Destination

One of: Inbox/Application.

Inbox = Go to EM Inbox.

Application = Go to List of Applications to Run.

 

Login As

In case of Superuser privileges, login as another user to his Inbox.

 

Data Grp

Select a Data Group for this session.

 

First Screen 

One of: Default, Search, MyMenu.

Select the screen to go to after sign-in.

 

Notes:

  • Login As: Superuser privileges are availed via definition of Application Registration as type Superuser by grantor and subscription to this role by grantee.
  • Data Grp: Only valid data groups for this User ID can be selected, or else sign-in will fail.
  • In case of using ‘Login As’ and ‘Data Grp’ both: Data Group belonging to ‘Login As’ user is verified for validity.

 

 

 

Search Links on Sign-In Screen

 

Sign-In Screen has Search links on right side , which can be used by Public Users (i.e. not registered on site users)

 

Use this screen to search for User/Application/Web Pages marked for Public Access, i.e. access to EM 5.0 without supplying a User Id or Password. The public search allows to search on User Info and WebProject screens only when explicitly marked so.

 

Following information on Users is always Public:

  • User Id
  • Display Name
  • His Photo For Public Profile (File: app0.jpg) and
  • Public Profile uploaded by him.

 

Following Links are present:

 

Search

      User Search | Search Links 

 

Applications (Content Type, Public Access) 

      Content App Home | App Search | App List 

 

Collaboration (Public Access) 

      Collaboration Home | Collaboration Search 

 

Portal (Direct Access URLs) 

      Portal Home | Portal Search (DAU) 

 

 

Screen Snapshot: Public Search

 

Please refer to “Portal User Guide” chapter Potal Search for details on using this screen.

 

 

Sign-Out


When invoking
Sign-Out link, the User ID is signed out and a confirmation screen is displayed with message like:

 

User: [User ID],    Inbox/App: [User/App Id],    Signed Out!

 

Screen Snapshot: Sign-Out

 

Sign-Out Screen has following information fields and menu options.

 

 

User

User ID i.e. sign-in User Id.

 

Inbox/App

Same as User ID, except when sign-out from application then it’s App Owner’s Id.

 

Home/Sign-In

Link to go to Sign-In screen.

 

 

 

Sign-In Using Third Party Accounts



When available, you would see the options to Sign-In using Third party Accounts as setup by your Hosting Administrator on Sign-In page.

 

Once selected, The Third party account Menu will display allowing you to select Login or Logout. With Third Party Login selected, it will pop-up window to Sign-In to provider login page and once Signed-In there, You will have option to Sign-In to EM. If it is your first time, then an EM User Sign-Up page is displayed to capture minimum Sign-Up info.

 

Also for the users who already have EM accounts and want to Add Third Party Sign-In Account, option will be available under:

“Options: Member Accounts: Add Third Party Account to SignIn With”

 

 

Access Via Mobile Phones, Mobile Devices


You can access the EM 5.0 via Mobile Phones at following location:

http://127.0.0.1:8000/em/m

 

This is Supported on Opera for phones (http://www.opera.com/mobile/) Browsers.

 

 

 

Chapter 3: Solution, Table & Data Designing with EM


This chapter describes the different ways of designing your tables, organizing data for use with EM WebPlus products and guides on selecting the suitable strategies.

 

 

Design Pillars (Criteria)

 

Some of the broad criteria or design pillars are based on: do you need to use following? In many cases, a mix of following will be used, where your solution also can be partitioned to have suitable components or parts.

 

EM Tables [DEF] Not Linked: These are the special tables available to developers, the data operations are handled by EM WebPlus engine.

 

EM Tables [LN] Linked: These are the physical tables in database (with 2 additional columns for EM use), the data operations are handled by database.

 

Data Groups: These are groups or departments using same applications but needing their data be kept as a group. E.g. use of defect (bug) tracking app by Quality and Customer Service Depts.

 

LookUp Tables: This is the way of defining special tables where look-up data is available to receiver application users or Ids for lookup and reference key checks.

 

Collaboration Needs: Business users needing to compose and pack their application and data in an e-mail to send out or take along. Or having need to collaborate/ exchange their application and data with other business users. E.g. healthcare: patient records, university: student research projects.

 

 

Defining your Solution, Application or Product Use

 

Some of the examples of solutions or applications using EM products are detailed below. They will guide you as a reference on your particular need. Each example lists how it uses the design pillar explained earlier. In reality a solution might need multiple parts with hybrid approach from these examples.

 

Enterprise Application (Component):

This is a generic, most common application solution form. E.g. Corporate, Finance, Manufacturing, HR, Admin Apps

It uses features like:

  • All the transaction tables can be EM Table [DEF] or [LN] Linked (when very large amount of data is stored).
  • For Lookup tables, it is advisable to use separate Inbox Id.
  • Application authorizations will heavily use data groups.
  • No collaboration needs, so app only users.

 

Example: HR Application

 

User Id (Role)

EM Id Type

Usage

CORPORATE

Self Inbox/App Owner

Owner of all lookup tables. E.g.

DeptMaster

EmployeeMaster

HR

Application Owner

Owner of HR application. Has 3 divisions (data groups): Mgmt, Engineering and all others. The application component where salary is defined is accessible by HR manager, supervisor and Dept managers.

Application Authorizations:

  • HR Administrator
  • HR Supervisor – Mgmt/Eng/Other
  • HR User – Mgmt/Eng/Other
  • HR Payroll User

Mike

(HR Manager)

User

Is named user having privileges:

  • HR Administrator
  • HR Payroll User

Linda

(HR Team Leader)

User

Is named user having privileges:

  • HR Supervisor - Eng
  • HR Payroll User

Cindy

(Recruiter - Eng)

User

Is named user having privileges:

  • HR User - Eng

John

(Development Mgr)

User

Is named user having privileges:

  • HR User (Eng Group)
  • HR Payroll User (Eng Group)

 

 

Web Application without collaboration needs:

This is enterprise web solution with business users using the solution as app users. E.g. University Online application System component of University Smart Web Suite.

It uses features like:

  • The transaction tables mostly EM Table [DEF], or [LN] Linked (when very large amount of data is stored).
  • For Lookup tables, use same Inbox Id.
  • Application use will be as app user.
  • No collaboration needs, so app only users.

 

Example: University Online application System

 

User Id (Role)

EM Id Type

Usage

ADMOFF

Self Inbox/App Owner

Admissions Office App Owner and owner of all lookup tables. E.g.

DeptMaster

ProgramMaster

StudentMaster

UnivOnline

Application Owner

Owner of Univ Online Apply app. Used by students on internet, and admissions office and various university dept staff and faculty.

Application Authorizations:

  • AdmOff Administrator
  • AdmOff User
  • Dept User
  • Student

Mike

(AdmOff Manager)

User

Is named user having privileges:

  • AdmOff Administrator

Linda

(Computer Science dept)

User

Is named user having privileges:

  • Dept User

Cindy

(Student)

User

Is named user having privileges:

  • Student

John

(Faculty Comp Sci)

User

Is named user having privileges:

  • Dept User

 

 

Web Application with collaboration needs:

This is enterprise web solution with discrete Inbox Users need. E.g. Finance People Profiles (for Banking, Cards, Insurance), Healthcare: Clinical Data Systems, Drug Research

It uses features like:

  • The transaction tables are all EM Table [DEF]
  • For Lookup tables, it is advisable to use separate Inbox Id.
  • Application use will be as app user or Inbox App types.
  • Collaboration needs demand using separate Inbox Ids for business users. E.g. when patient John get discharged or referred to other institute, all his clinical data with app schema can be composed in e-mail and sent to other institute.

 

Example: Patient Medical Record

 

User Id (Role)

EM Id Type

Usage

CLINMAST

Self Inbox/App Owner

Owner of all lookup tables relating to clinical data (owned by medical records dept or doctor). E.g.

DiagnosisMaster

DrugMaster

CORPMAST

Self Inbox/App Owner

Owner of all lookup tables for institute other than clinical data. E.g.

FeesMaster

DeptMaster

MedRec

Application Owner

Owner of patient medical records app. Schema. And also App SU for multi-inbox querying purposes.

Used by institute staff and doctors and patient via internet (limited access). The application example uses separate Inbox for each patient.

Application Authorizations:

  • Collaboration
  • Superuser – MedRec

For a limited branch e.g. view discharge summary, Rx or appt status, etc.

  • MedRec – Patient User (1 Rec)

For a limited access e.g. third party patient data access etc.

  • MedRec – Third Party Usr (1 Rec)

Mike

(Hospital Administrator)

User

Is named user having privileges:

  • App SU
  • Superuser - MedRec

Linda

(Doctor – Paediatrics)

User

Is named user having privileges:

  • Superuser - MedRec

Cindy

(Doctor - Surgery)

User

Is named user having privileges:

  • Superuser - MedRec

JohnRec

(PatientRecord)

Self Inbox/App Owner

Is self inbox/app user who will receive appl schema via collaboration privileges

  • Collaboration receiver.

GeorgeRec

(Patient)

Self Inbox/App Owner

Is self inbox/app user who will receive appl schema via collaboration privileges

  • Collaboration receiver.

John

(Patient)

User

Is named user having privileges:

  • MedRec – Patient User (JohnRec)

Dr Philip

(John’s Referring Doctor)

User

Is named user having privileges:

  • MedRec – Third Party User (JohnRec)

Bill

(John’s Insurance Plan Person)

User

Is named user having privileges:

  • MedRec – Third Party User (JohnRec)

 

 

 

 

 

EM WebPlus Studio 5.0


This guide describes the Studio features for developers and users.

 

 

Chapter 1: EM Inbox

 

 

What is EM Inbox


EM Inbox is the developer work environment providing access to various development functions and menus. EM Inbox consists of following modules and menu options:

 

  • Inbox: Inbox module allows organizing the EM Objects into different categories such as Explorer, Trash, Archives, Application Tree.
  • Application: This module is used to define different applications, data groups, user authorizations.
  • Options: Users can set variety of Inbox options, defaults.
  • Mail Box: Module to manage EM Mail which allows to exchange app-data via e-mail.
  • Collaboration
  • Search
  • Settings
  • Tools
  • Sign Out: Menu option for signing out of present session.
  • Help: For help screens on EM 5.0 product.

 

Screen Snapshot: Inbox - Explorer

 

Each module in EM Inbox is described in detail in the coming sections.

 

Inbox Module


Inbox provides Menus for organizing the EM Objects (folders, tables and webprojects) into different categories as Explorer, Trash, Application Tree. When you select a tree you get listing of objects in that branch. The menu options for a object depend upon it’s presence in a particular tree. E.g. In Trash only Cut[Move] is allowed but no Edit/Copy. Each Menu option in Inbox is detailed in sections below or separately. To list them, the options are:

  • Explorer
  • Explorer_PLUS/ POWER Search
  • Trash
  • Archives
  • Application Tree
  • My Menu
  • Updates
  • Welcome

 

 

Default Destination Inbox – Explorer


The default destination when you sign in to Inbox is Inbox - Explorer. This is the work area to create EM Objects test them before deploying into Apps. Also this area will store EM Tables not requiring App User access. For application development and enhancement create a new folder and put your work in that until you are ready to move objects to Application tree.

 

Screen Snapshot: Inbox - Explorer

 

Screen Details:

 

The Inbox - Explorer screen has following information fields and options.

 

  • Selected Folders: The top line shows the folders selected in the Inbox tree. Each successive selection is appended at the end.
  • Display Tree|One Level: The Menu Display [Tree/One Level] is toggle option and shows the objects at one level or expanded tree.
  • XML File: Option to view XML formatted information of current EM Object branch or tree as applicable.

 

Here is the display after Clicking [Tree] link, i.e. with expanded tree:

 

Screen Snapshot: Inbox - Explorer (Tree)

 

  • Branch level Menus: The screen has Branch level menu options [Create New] [Paste] [Clear Copy]   [ClearSend Session All]. Where:
    • Create New: Option to create new EM Objects.
    • Paste: Option to Paste previously Copy/Cut[Move] marked EM Object (including sub-tree), in this branch.
    • Clear Copy: Option to clear-up “Copy” marking of all EM Objects.
    • ClearSend Session: Option to clear-up “MarkSend” marking of all EM Objects made during current session.
    • ClearSend All: Option to clear-up “MarkSend” marking of all EM Objects made in all sessions including current one.
  • EM object level fields and Menus: Has fields Category Id (i.e. object Id), Object type as [E] [T] [W], Object Name, and Object Menu options (Edit, Del, Archive, Copy, Cut[Move], Paste, MarkSend). Important Object Menu options are detailed in separate sections below.
    • MarkSend: Marks the EM Object entry (as Explorer Node or Category) for EM Mail Compose.

 

Selecting a folder:

After clicking on one folder the explorer relocates to that folder level and only objects belonging to that folder branch are displayed, as in screen below.

 

Screen Snapshot: Explorer - Folder Selected

 

 

Inbox - Trash, Archives, Application Tree


These are the other trees in Inbox. This is the work area to create EM Objects test them before deploying into Apps. Also this area will

Trash

Holds the deleted EM Objects (including sub-folders/objects of deleted EM objects). Only Cut[Move] action is allowed on objects to unTrash them.

Screen Snapshot: Inbox - Trash

There is option to Clean-up Trash completely which is non-reversible action.

Screen Snapshot: Inbox - Trash Clean-Up
 

Archives

Holds the archived EM Objects (including sub-folders/objects of archived EM objects).

Screen Snapshot: Inbox - Archives

 

Application Tree

This is the default tree available for App users. Deploy your application objects under this tree using Cut[Move] and Paste.

Screen Snapshot: Inbox - Application Tree

 

Inbox - My Menu


This option allows customizing of Menu Options as per user needs and to be displayed as your personalized Menu. It is available for EM Inbox and For all application registrations. If multiple applications are defined on a specific Category Id, they will get same My Menu for that Category Id.

How to create My Menu:

Create a html file (without HEAD and BODY tags), customize it as per your needs, you can put in all the links available to you under EM Inbox (or application run as the case may be). Then Upload the file (See the Upload My Menu Option below) as My Menu.

On selecting My Menu link, the contents of the uploaded file will displayed.

If there is no customized file available you will get Error Message as, e.g.:

Custom Menu not defined, file [DEMO.html] not found !

Tip: You can directly land-up in My Menu screen after sign-in via using “Advanced Sign-In Options” link instead of Sign-In.

 

Inbox – User Search


This screen allows for search on users and their information marked accessible for authorized users. Also user’s Apps and Portal DAUs can be searched further.

Use this screen to search for Users / Inboxes / Applications.

 

The quick Search is allowed on

  • User’s Display Name

 

The Advanced Search is allowed on

  • User’s Info (User Id, User Name, Keywords). Along with:
  • User’s Display Name
  • Dates criteria, The user account created or updated in specified date range.

 

The query results will display matching given criteria. Once you locate the user, then further search links on that user are presented.

 

Chapter 2: EM Objects - Folders, Tables, WebProjects

 

EM Objects are:

  • Folders (or Text Entries)
  • EM Tables
  • WebProjects

 

Folders or Text are like directory entries which will hold object sub-tree. Em tables are special tables to be used in the app development. When not linked to database table (default mode) they are managed by EM Server Engine and give a lot of flexibility. When linked to database table they act as interface to already present table in Database. WebProjects are program modules deciding the flow of app.

 

Creating EM Objects


To create new EM Objects in Explorer select link [Create New]

 

Screen Snapshot: EM Object - Create New

 

On the Create Entry Screen fill out:

 

 

Entry Type

Select one of: Folder or Text, Table, WebProject

 

Name

Name Of the Entry

 

Note:

a) Following characters are not allowed in the name and filtered on input:

# & % " < >

 

b) If the entity is table which is Linked to RDBMS table, then Use only ASCII chars in name.

 

Once created, EM Object options available are: Edit, Del, Archive, Copy, Cut[Move], Paste. Paste option is only available for Folder or Text type.

 

EM Objects – Edit


 

To edit EM Objects in Explorer select link [Edit]

 

Screen Snapshot: EM Object - Edit

 

On the Edit Entry Screen fill out:

 

Name

Name Of the Entry

 

Display Order

To modify present location within parent category

 

Level

To modify indentation displayed

 

Note:

Display Order and Level are provided for ‘when copy/cut followed by paste’ entries  go out of sync in terms of display. They are mostly cosmetic properties although maximum levels allowed are 20.

 

Following characters are not allowed in the name and filtered on input:

# & % " < >

 

 

EM Objects – Del

 

To Delete (Move to trash) EM Objects in Explorer select link [Del]

 

Screen Snapshot: EM Object - Delete

 

Confirmation screen is displayed showing all the sub-levels of that Em Objects e.g.:

 

Entry Delete (Move to Trash - All Following, Including Data) : Confirm ?

       [E] BILLPAY Tables       

       ---[T] PayMethods       

       ---[T] Bills       

       ---[T] Billers       

       ---[T] Registration Data        

       ---[T] Payments       

    CANCEL

 

EM Objects – Archive


To Archive (Move to Archive tree) EM Objects in Explorer select link [Archive]

 

Screen Snapshot: EM Object - Archive

 

Confirmation screen is displayed showing all the sub-levels of that EM Objects.

Entry Archive (Move to Archive - All Following, Including Data) : Confirm ?

       [E] BILLPAY Tables       

       ---[T] PayMethods       

       ---[T] Bills       

       ---[T] Billers       

       ---[T] Registration Data       

       ---[T] Payments       

    CANCEL

 

EM Objects – Copy


To Mark an EM Object (including sub-tree) for Copy, in Explorer select link [Copy]

 

The EM Object is internally marked for Copy. No confirmation screen is displayed. Marking for Copy is done at database level so once marked by one session it is effective for all the sessions of the particular user.

 

Note: Please see Scope Of Copy & Paste below.

 

EM Objects - Cut[Move]


To Move an EM Object (including sub-tree), in Explorer select link [Cut[Move]]

 

Screen Snapshot: EM Object - Cut[Move]

The EM Object is marked for Cut[Move], and is removed from present display. Marking is done at database level so once marked by one session it is effective for all the sessions of the particular user.

 

EM Objects – Paste


To Paste previously Copy/Cut[Move] marked EM Object (including sub-tree), in Explorer select link [Paste]

 

Screen Snapshot: EM Object - Paste

 

Confirmation screen is displayed. The marked Em Object(s) are pasted/copied below the selected folder level. The Copy/Cut[Move] markings are removed. This task is done at database level so once pasted by one session it is effective for all the sessions of the particular user.

 

Note: Please see Scope Of Copy & Paste below.

 

Scope Of Copy & Paste

 

What is copied from marked “Copy” tree to destination when Paste is selected:

Folders & Text: Entries are copied including sub-tree

EM Tables: Only minimal table definition including Fields and Form Id 1 are copied. Additional Forms, queries, join definitions, keys, table data are not copied.

WebProjects: Not copied.

 

Note: To Copy complete EM Objects trees including all Object properties and Table Data , etc. , please use advanced feature of EM Mail interface. Compose a mail, import it and move it to Inbox as COPY.

 

 

Chapter 3: EM Tables

 

 

EM FlexiTables

 

EM Tables are also known as FlexiTables due to the flexibility in definition they offer. Please refer to EM Tables for details.

 

EM Tables - Special Table Objects

 

EM tables are special table objects, which are integral part of EM Technology. There are two categories of tables:

1. My Table

2. Db Table

 

A table can be switched to any of these 2 categories any time by developer. These types are detailed below.

 

EM Technology has unique features being ability to define table, manipulate data, change definition thru browser interface.

 

The table types mentioned below extend the 2nd categories further:

  1. My Table - EM Table [DEF] (not linked to database),
  2. Db Table - EM Table [LN] (linked to database),
  3. Db Table DirectAccess - EM Table [LN-DA] (Linked to database and marked for Direct Access).

 

Based upon the needs of application, a category is selected based upon following criteria: No Of Rows per User, Flexibility (Addition/Deletion of field), Table Extentions.

 

 

EM Tables – My Table

 

Also known as: EM Table [DEF] (not linked to database)

When you create an EM Table it is placed in this default category. This is virtual table in a way that there is no new physical separate table in database and the data storage will be handled by EM Engine into fixed EM system tables.

 

These tables offer unlimited flexibility. There is a lot of room for trials. You can add/edit/delete fields. Build queries, WebForms, develop apps. Table definitions can be changed* even after deploying apps.

* Some restrictions apply.

 

 

EM Tables – Db Table

 

Also known as: EM Table [LN] (linked to database)

When you mark an EM Table as “Linked to DBMS” it is placed in this category. There should be a physical table or view with column sub-set equal to EM table columns plus 2 additional columns (CL_User, CL_VAL_ID). Now the data storage is channeled to the physical table in the database.

 

These tables offer similar functionality in terms of flexibility as EM tables [DEF]. You can add/edit/delete fields contingent upon similar actions on physical tables. Build queries, WebForms, develop apps. Table definitions can be changed* even after deploying apps.

* Some restrictions apply.

 

 

EM Tables – Db Table DirectAccess

 

Also known as: EM Table [LN-DA] (Linked to database and marked for Direct Access)

You can mark EM Table [LN] for “Direct Access” or “Direct Access User”.The additional columns CL_User is not required in first and CL_VAL_ID is not required in both.

 

LN-DA Mode is useful for Reports, Accessing Table Views, GROUP BY Views.

LN-DA Mode is also useful when you can not add EM required columns to your existing tables but would like to use them in apps or Data Viewer.

 

These tables offer similar functionality except that user-table access authorization can not be handled by EM Security.

 

 

Set Minimum Options


Before defining your first table, take a look at the default settings under options which will apply to your definition. Navigate to [Options
ŕ Default Form Properties, Default Field Properties and User Profile].  You can make changes to these settings as required.

 

Screen Snapshot: Inbox - Options

 

  • Default Form Properties: Defines the WebForm cosmetic and other properties like form orientation, table border, background color, etc.
  • Screen Snapshot: Default Form Properties

 

  • Default Field Properties: Defines the field cosmetic, validation and other properties like prompt font/size/color, data font/size/color , data mandatory, hide yes/no, etc.
  • Screen Snapshot: Default Field Properties

 

  • User Profile: Defines user profile and date & time formats for display, input. Also numeric and money display formats, currency sign, etc.
  • Screen Snapshot: User Profile

 

 

Table Options – No Fields


When first time table object is selected and there are no fields defined for the table, the table options are as below.

 

Define Fields

To define fields from scratch.

 

Import & Define Fields

To import field definitions from an existing database table. (Note - This option is not available for all databases.)

 

[UnDelete Fields]

When all the fields of a table are deleted, table menu is set to first time setting. Use this menu option to restore fields back.

 

Screen Snapshot: Table - Menu (No Fields)

 

 

Define EM Table Fields


Use this option to define a new EM Table.

 

  • For EM Table [LN] Linked to database, only the fields definition of EM Table is created in EM dictionary, no attempt is made to create actual columns or physical table, that is user responsibility.

 

To define new Fields, enter the attributes as below. The field name is mandatory otherwise the line is ignored.

 

 

Field Order

Order of the field on WebForms, query wizard, etc.

 

Field Name

Name of the field. Spaces and special characters allowed except that following chars not allowed

# & % < > "

 

Field SQL ID

Fields SQL column name in database table. This is optional for EM Table not linked to database.

 

Data Type

EM Datatype of the field. Details given below.

 

Size

The maximum size of the field. (Note - In case of TEXT/TEXTS datatypes this attribute defines number of lines for input textarea.)

 

Display Size

The size to be displayed on screen. (Note - In case of TEXT/TEXTS datatypes this attribute defines number of columns for input textarea.)

 

Screen Snapshot: Table - Define Fields

 

Import Field Definitions from database Table

 

When importing field definitions from an existing database table, the field list is populated with default conversion attributes. Please verify the attributes, make changes and then submit.

 

Note: This option is available for Oracle, MS SQL Server, MySQL.

 

Screen Snapshot: Table - Import and Define Fields

 

 

EM Data Types With MySQL, Oracle, MS SQL Server

 

EM Data Types supported for EM tables are described in table below. Also some future additions are highlighted.

 

 

EM Data Type

Database

Database Data Type

Db Notes

Usage

 

CHAR

 

MySQL

VARCHAR(2000)

 

Any char data. (Max Size 2000)

 

 

Oracle

VARCHAR2(2000)

 

 

 

 

MS SQL

VARCHAR(2000)

 

 

 

NUMBER

MySQL

INT / INTEGER

 

Any numbers.

 

 

Oracle

NUMBER(10)

 

 

 

 

MS SQL

INT

 

 

 

MONEY

MySQL

DECIMAL(38,6)

See below

Money values

 

 

Oracle

DECIMAL(38,6)

 

 

 

 

MS SQL

DECIMAL(38,6)

 

 

 

DATE

MySQL

TIMESTAMP

 

Only Date

 

 

Oracle

TIMESTAMP WITH TIME ZONE

 

 

 

 

MS SQL

DATETIME

 

 

 

DATETIME

MySQL

TIMESTAMP

 

Date & Time

 

 

Oracle

TIMESTAMP WITH TIME ZONE

 

 

 

 

MS SQL

DATETIME

 

 

 

TIME

MySQL

TIMESTAMP

 

Only Time

 

 

Oracle

TIMESTAMP WITH TIME ZONE

 

 

 

 

MS SQL

DATETIME

 

 

 

FLOAT

MySQL

DECIMAL(38,6)

See below

Numeric values with precision and scale.

 

 

Oracle

DECIMAL(38,6)

 

 

 

 

MS SQL

DECIMAL(38,6)

 

 

 

BOOLEAN

MySQL

VARCHAR(1)

 

 

 

 

Oracle

VARCHAR2(1)

 

 

 

 

MS SQL

VARCHAR(1)

 

 

 

TEXTS

MySQL

VARCHAR(4000)

Kept as per other Db.

Character Paragraphs as Textarea.

 

 

Oracle

VARCHAR2(4000)

Oracle VARCHAR2 max size is 4000.

 

 

 

MS SQL

VARCHAR(4000)

Kept as per other Db.

 

 

TEXT

MySQL

MEDIUMTEXT

Length upto 16,777,215.

Character Paragraphs as Textarea.

 

 

Oracle

LONG

Length upto up to 2 GB -1.

 

 

 

MS SQL

VARCHAR(MAX)

See below

 

 

HYPERLINK

MySQL

VARCHAR(2000)

 

Hyperlink: <A HREF=”URL”> Text </A>

(Max Size 2000)

 

 

Oracle

VARCHAR2(2000)

 

 

 

 

MS SQL

VARCHAR(2000)

 

 

 

FILE

MySQL

MEDIUMBLOB

Length upto 16,777,215.

Any file or image

 

 

Oracle

BLOB

Length upto up to: (4 GB -1) * (Db block size).

 

 

 

MS SQL

VARBINARY(MAX)

See below

 

 

Note:

  • NUMBER Type:
    • MySQL | MS SQL: INT : The Range of values is -2,147,483,648 to 2,147,483,647
    • Oracle: NUMBER(10) : The Range of values is -9,999,999,999 to 9,999,999,999
  • MONEY & FLOAT Type:
    • DECIMAL(38,6): 38 is the precision and 6 is the scale. The precision represents the number of significant digits that are stored for values, and the scale represents the number of digits that can be stored following the decimal point. The Range of values is –(n…32.n…6) to (n…32.n…6)
  • BOOLEAN: Is implemented as Varchar(1) and accepts any 1 char. Recommended Use Y/N/T/F.
  • TEXTS | TEXT : The display input is thru TEXTAREA. Client Web Server h/w limitations will determine how large it can be.
  • HYPERLINK: Hyperlink is accepted as 2 parts on input/edit i.e. URL and Text. But displayed as Hyperlink in browser.
  • FILE: FILE is handled differently than other datatypes. It is stored/downloaded only on demand for a particular row.
  • Date, Datetime and Time types: Implemented as single database type, The formats define what parts are input or displayed.
  • MS SQL Server: VARCHAR(MAX) | VARBINARY(MAX) | TEXT | IMAGE: Maximum storage size is: 2,147,483,647.

 

 

MySQL Data Types supported for EM Table [LN] and [LN-DA]:

 

Mapping for MySQL Data Types with EM Data Types for EM Tables [LN] and [LN-DA] is given below.

 

 

Database Data Type

Remark/Use

EM Data Types Can Map To

 

CHAR (1..255)

 

CHAR

 

CHAR (1..255)

 

TEXTS

 

CHAR (1..255)

 

TEXT

 

VARCHAR (1..2000)

 

CHAR

 

VARCHAR (1..4000)

 

TEXTS

 

VARCHAR (1..65535)

 

TEXT

 

 

FOR CHAR | VARCHAR types: Use TEXTS | TEXT if wish to input/display as TEXTAREA on browser.

TEXTS

 

TEXT

Size from 1 to 65535

TEXT

 

MEDIUMTEXT

Size from 1 to 16,777,215

TEXT

 

 

 

 

 

SMALLINT

MEDIUMINT

INT

INTEGER

 

NUMBER

 

BIGINT

 

FLOAT

 

DECIMAL(p,s)

Money values needing currency symbol. Upto size DECIMAL(38,6).

MONEY

 

DECIMAL(p,s)

Upto size DECIMAL(38,6)

FLOAT

 

FLOAT

Numeric values with precision and scale. DECIMAL(38,6)

FLOAT

 

 

 

 

 

DATE

Only Date

DATE

 

DATETIME

TIMESTAMP

Date & Time

DATETIME

 

DATETIME

TIMESTAMP

Only Time

TIME

 

TIME, YEAR

 

CHAR

 

 

 

 

 

BINARY

(Stream Type)

STREAM

 

VARBINARY

(Stream Type)

STREAM

 

TEXT types

(Stream Type)

STREAM

 

BLOB/CLOB

(Stream Type)

STREAM

 

ENUM, SET

 

*N/S

 

 

 

*N/S: Not Supported

 

Oracle Data Types supported for EM Table [LN] and [LN-DA]:

 

Mapping for Oracle Data Types with EM Data Types for EM Tables [LN] and [LN-DA] is given below.

 

 

Database Data Type

Remark/Use

EM Data Types Can Map To

 

CHAR (1..2000)

 

CHAR

 

CHAR (1..2000)

 

TEXTS

 

CHAR (1..2000)

 

TEXT

 

VARCHAR2 (1..2000)

 

CHAR

 

VARCHAR2 (1..4000)

 

TEXTS

 

VARCHAR2 (1..4000)

 

TEXT

 

 

FOR CHAR | VARCHAR types: Use TEXTS | TEXT if wish to input/display as TEXTAREA on browser.

TEXTS

 

 

 

 

 

NUMBER(n)

Size upto NUMBER(10)

NUMBER

 

NUMBER(n)

Size > NUMBER(10)

FLOAT

 

INT / NUMBER(38)

 

FLOAT

 

NUMBER(p,s)

Money values needing currency symbol. Upto size NUMBER(38,6).

MONEY

 

NUMBER(p,s)

DECIMAL(p,s)

Upto size NUMBER(38,6)

FLOAT

 

FLOAT

Numeric values with precision and scale. DECIMAL(38,6)

FLOAT

 

 

 

 

 

DATE

Only Date

DATE

 

DATE

Date & Time

DATETIME

 

DATE

Only Time

TIME

 

 

 

 

 

ROWID

 

CHAR

 

LONG/LONG RAW

(Stream Type)

STREAM

 

BLOB/CLOB

(Stream Type)

STREAM

 

BFILE

 

*N/S

 

 

 

*N/S: Not Supported

 

 

MS SQL Server Data Types supported for EM Table [LN] and [LN-DA]:

 

Mapping for MS SQL Data Types with EM Data Types for EM Tables [LN] and [LN-DA] is given below.

 

 

Database Data Type

Remark/Use

EM Data Types Can Map To

 

CHAR (1..2000)

 

CHAR

 

CHAR (1..4000)

 

TEXTS

 

CHAR (1..8000)

 

TEXT

 

VARCHAR (1..2000)

 

CHAR

 

VARCHAR (1..4000)

 

TEXTS

 

VARCHAR (1..8000)

 

TEXT

 

 

FOR CHAR | VARCHAR types: Use TEXTS | TEXT if wish to input/display as TEXTAREA on browser.

TEXTS

 

VARCHAR (MAX)

 

TEXT

 

TEXT

Size from 1 to 2,147,483,647

TEXT

 

 

 

 

 

TINYINT

SMALLINT

INT

 

NUMBER

 

BIGINT

 

FLOAT

 

MONEY

SMALLMONEY

Money values needing currency symbol. Upto size DECIMAL(38,6).

MONEY

 

DECIMAL(p,s)

NUMERIC(p,s)

Upto size DECIMAL(38,6)

FLOAT

 

FLOAT

Numeric values with precision and scale. DECIMAL(38,6)

FLOAT

 

 

 

 

 

DATE

Only Date

DATE

 

DATETIME

DATETIME2

DATETIMEOFFSET

Date & Time

DATETIME

 

DATETIME

Only Time

TIME

 

TIME

SMALLDATETIME

 

CHAR

 

 

 

 

 

BINARY

(Stream Type)

STREAM

 

VARBINARY

(Stream Type)

STREAM

 

IMAGE

(Stream Type)

STREAM

 

TEXT

(Stream Type)

STREAM

 

cursor

 

*N/S

 

 

 

*N/S: Not Supported

 

 

File  (Document) Type

 

FILE can be defined as a column for EM Table. This type will hold any file, document, image, etc. Following are features and advantages of this functionality.

 

  • Each data record or row can store a FILE.
  • After a data record or row is added and viewed, options for FILE download or upload/refresh are displayed.
  • The size limit of FILE for upload or download is set individually in EM configuration parameter file, default 2 MB.
  • FILE upload or download can be disabled by setting the respective parameter size to 0 (zero).

 

 

Date Formats


Date Time Formats:

  • These formats are user definable and separated into:
  • DATE formats and TIME formats
  • DATETIME formats inherit “DATE Format” + “ ” (space) + “TIME Format”.
  • The formats for display and input can be defined separately.
  • Please select your date and time formats on User profile screen.

Please refer to Chapter “Options : Member Account: Update User Profile” for details.

 

Screen Snapshot: User Profile

 

 

Table Options Menu


Table Options menu is displayed on successful definitions of fields for table.

 

Screen Snapshot: Table - Menu

 

Table Options Screen has following information fields and menu options.

 

Table Options: Section I

 

 

Table Info

Displays the EM table number, date created, No Of fields and whether linked to database table.

 

 

 

 

Definition Options

 

 

View Fields  

View active field definitions for the table.

 

Edit/Add Fields  

Add or Edit a field definition. Datatype change not allowed but can be achieved via “Delete and Add”.

 

Copy From (Add Fld)  

Add a field by : query and select an existing field, which will be copied to current table.

 

Delete Fields    

Delete a field from EM Table definition. Does not delete it from database table.

 

UnDelete Fields  

UnDelete a previously deleted field definition.

 

   

 

 

Unique Keys  

Define EM Unique key constraints for the table. These are not RDBMS unique keys but enforced via EM 5.0.

 

Foreign Keys  

Define EM Foreign key constraints for the table. These are not RDBMS foreign keys but enforced via EM 5.0.

 

Link to RDBMS Table  

Link the EM table definition to the RDBMS table with same name. No Confirmation screen displayed. Any data input or queried will go to or come from RDBMS table.

 

RDBMS Table (UnLink)  

UnLink the EM table definition from the RDBMS table. No Confirmation screen displayed. Any data input or queried will be from EM system tables.

 

   

 

 

Properties  

Define EM Table properties.

 

   

 

 

Table Join (Data Copy Table-to-Table)  

Go to Table Join Menu which allows to define 2 EM Table column join definitions, copy data, update data on table level.

 

Table Schema

Generate table schema for this table. Please refer to chapter “Options: Generate Table Schema”.

 

List WebProjects

List WebProjects which use this table.

 

Data Options

These options do not access the table via any form but are direct access. They allow for debugging if a particular form is giving problem.

 

Input Data

Input data (no form).

 

Archived Data

View data records marked for archive, option to UnArchive.

 

UnDelete Data

View data records marked for deletion, option to UnDelete.

 

Query Options

These options do not access the table via any form but are direct access. They allow for debugging if a particular form is giving problem.

 

View Data – All

View all the data records (no form).

 

New Query

Query the table with query wizard (no form). When query is saved from this option form # 1 is used.

 

Saved Queries

View previously saved queries for this table for all the forms.

 

 

Table Options: Section II: WebForms

 

  • This menu displays the forms created on the table.
  • Form # 1 is created by default and not allowed to delete.
  • The data options on a form access the table via that particular form.

 

 

 

WebForms:

 

 

Form #

Displays the form number.

 

Edit

Edit the form, field or layout definition.

 

Copy

Copy the form into a new one. No confirmation screen displayed.

 

Delete

Delete the form, Form # 1 delete not allowed. No confirmation screen displayed.

 

Type

Form orientation type: Normal, Tabular, NormalLayout, etc.

 

Info

Form user defined info string.

 

Status

User defined form status.

 

Updated

Last update date.

 

Input Data

Input data using the form.

 

View Data - All

View all the data records using the form.

 

XML

View all the data records formatted as XML file using some of the form properties e.g. ‘Hide’.

 

MarkSend

Mark the EM Table object for EM Mail Compose (as Object, with the form id and all data).

 

New Query

Query the table with query wizard with form.

 

Saved Queries

View previously saved queries for this table for this forms.

 

 

View Fields


Use this menu option to view and verify the field definitions.

 

Screen Snapshot: Table - View Fields

View Fields Screen has following information fields and menu options.

 

 

Field Order

Order of the field on WebForms, query wizard.

 

Field Name

Name of the field. 

 

Field ID

Fields ID number.

 

Field SQL ID

Fields SQL column name in database table.

 

Data Type

EM Datatype of the field. 

 

Size

The maximum size of the field.

 

Display Size

The size to be displayed on screen.

 

 

Edit/Add Fields

 

Use this menu option to Edit or Add fields in the EM Table.

 

  • For EM Table [LN] Linked to database, only the fields definition to EM Table is added/edited, no attempt is made to edit/add actual column to physical table, that is user responsibility.
  • Some data issues related to Add Fields are as below.
  • For EM Table [DEF] Not Linked to database: For records that were inserted before the Add Field, there will not be any data for Added fields. This does not affect querying.
    • For all such fields, User remedy is to edit these records and input and save data to Added fields.
    • For FILE datatype fields will not allow file upload/download. User remedy is to do a dummy edit, where you edit the record and submit which will make provision for holding FILE data.

 

Screen Snapshot: Table - Edit/Add Field

 

Edit/Add Fields Screen has following information fields and menu options.

 

 

Srl

The serial number for the line.

 

Field Order

Order of the field on forms.

 

Field Name

Name of the field. Spaces and special characters allowed except that following chars not allowed

# & % < > "

 

Field SQL ID

Fields SQL column name in database table. This is optional for EM Table not linked to database.

 

Data Type

EM Datatype displayed but change not allowed.

 

Size

The maximum size of the field. (Note - In case of TEXT/TEXTS datatypes this attribute defines number of lines for input textarea.)

 

Display Size

The size to be displayed on screen. (Note – In case of TEXT/TEXTS datatypes this attribute defines number of columns for input textarea.)

 

 

Note: Field Order is not unique and used as sorting order of fields.

 

 

Copy From (Add Fields)

 

Use this menu option to Add fields in the EM Table via copy from existing fields.

 

Add a field by: query and select an existing field, which will be copied to current table. The query screen displays a form with table field selection criteria, upon submit will display a list of matching fields. Either an individual field can be selected or TblFldAll option allows to copy all the fields from that table into current table.

 

Some data issues as mentioned in “Edit/Add Fields” section are applicable for Copy Fields as well.

 

Screen Snapshot:

 

Copy From (Add Fields) Screen has following information fields and menu options.

 

 

Table Id

Table Id No.

 

Table

Table Name.

 

Field Id

Field Id No.

 

Field Name

Field Name.

 

Data Type

EM Datatype.

 

Size

The maximum size of the field.

 

Display Size

The size to be displayed on screen.

 

Field SQL ID

Fields SQL column name in database table.

 

Select

Select this field for copy and add.

 

Select TblFldAll

Select all the fields of the table for copy and add.

 

List WebProjects

List WebProjects where this table is used.

 

Created / Updated

Table created , last updated date.

 

 

 

Delete Fields

 

Use this menu option to delete fields from EM Table definition.

 

  • The deleted fields and associated data are marked for delete and are available for UnDelete, for a limited period. See under UnDelete Fields below for more information.
  • For EM Table [LN] Linked to database, only the fields definition from EM is deleted, no attempt is made to delete actual column and data from physical table, that is user responsibility.

 

Screen Snapshot: Table - Delete Field

 

Delete Fields Screen has following information fields and menu options.

 

 

Field Order

Order of the field on WebForms, query wizard.

 

Field Name

Name of the field. 

 

Delete

Option to select the field for deletion, confirmation screen displayed next.

 

Field ID

Fields ID number.

 

Field SQL ID

Fields SQL column name in database table.

 

Data Type

EM Datatype of the field. 

 

Size

The maximum size of the field.

 

Display Size

The size to be displayed on screen.

 

Screen Snapshot: Table - Delete Field - Confirm

 

Note: When ALL the fields are deleted, Table Options Menu changes to Table Options (with No Fields) Menu. You can select UnDelete Fields option to restore 1 or more fields upon which regular Table Options Menu will be available.

 

 

UnDelete Fields

 

Use this menu option to UnDelete previously deleted fields from EM Table.

 

  • The deleted fields are placed in Trash and are available for UnDelete, for a limited period, only if the clean-up jobs are not run by EM System Administrator yet.
  • The frequency of such jobs depends upon individual installations, but are recommended to be run at least once or twice a week.
  • Some data issues related to UnDelete are as below.
  • For EM Table [DEF] Not Linked to database: the UnDeleted fields with data are available again. However if any records were inserted after the field Delete, there will not be any data for UnDeleted fields for those records. This does not affect querying, although any FILE datatype fields will not allow file upload/download. User remedy is to edit these records and input and save data to UnDeleted fields.

 

Screen Snapshot: Table - UnDelete Field

 

UnDelete Fields Screen has following information fields and menu options.

 

 

Field Order

Order of the field on WebForms, query wizard.

 

Field Name

Name of the field. 

 

Deleted ? (When)

Yes/No, (If yes, Date deleted)

 

UnDelete

Option to restore (UnDelete) the field, no confirmation screen displayed.

 

Field ID

Fields ID number.

 

Field SQL ID

Fields SQL column name in database table.

 

Data Type

EM Datatype of the field. 

 

Size

The maximum size of the field.

 

Display Size

The size to be displayed on screen.

 

 

EM Unique Keys

 

Use this menu option to define EM Unique Keys (enforced by EM Engine) on fields of EM Table.

 

  • Allowed up to 5 unique keys each can be combination of 1 to 3 fields.
  • Only when Enable=Yes, keys enforced.
  • The keys are enforced or implemented as:
    • Value entered should not exist in previous record. Implemented as check whether current data value exists in previous data records using SQL query, where column = column comparison.
    • Values not entered i.e. NULL (in database terms) or different number of space (blank) chars are allowed with this implementation. If this is not desired then unique key columns also need to be defined, at form level, as Input Mandatory with Minimum Length of at least 1 char to filter out differing number of spaces (blanks).
  • The data records added before definition of a unique key or during disabled phase are not scrutinized when key is defined or enabled. User remedy (for now) is to copy EM Table object, define Table Join, copy data to other table then copy it back with keys enabled. The Data Copy operation verifies EM Keys constraint.
  • For EM Table [LN] Linked to database: No EM Unique key definitions added to physical table. If the underlying physical table had any database table unique key constraints, they will error out before EM Unique Keys.

 

Screen Snapshot: EM Unique Keys

 

Unique Keys Fields Screen has following information fields and menu options.

 

 

Srl

The serial number for the line.

 

Enable

Yes/No, Enforced only when set to Yes.

 

Field ID

Fields ID number for the 1st key column.

 

+ Field ID

Fields ID number for the 2nd key column.

 

+ Field ID

Fields ID number for the 3rd key column.

 

 

EM Foreign Keys

 

Use this menu option to define EM Foreign Keys (enforced by EM Engine) on fields of EM Table.

 

  • Allowed up to 5 foreign keys, each on 1 field linking to foreign table’s 1 field.
  • Only when Enable=Yes, keys enforced.
  • The keys are enforced or implemented as:
    • Value entered should exist in the foreign table’s field value of any record. Implemented as check whether current data value exists in foreign table data records using SQL query, where column = column comparison.
    • With this implementation: Values not entered i.e. NULL (in database terms) are not allowed although foreign table field has NULL value record. Spaces are allowed, if equal number of spaces are present in foreign table field record.
  • The data records added before definition of a foreign key or during disabled phase are not scrutinized when key is defined or enabled. User remedy (for now) is to copy EM Table object, define Table Join, copy data to other table then copy it back with keys enabled. The Data Copy operation verifies EM Keys constraint.
  • For EM Table [LN] Linked to database: No EM Foreign key definitions added to physical table. If the underlying physical table had any database table foreign key constraints, they will error out before EM Foreign Keys.

 

Screen Snapshot: EM Foreign Keys

 

Foreign Keys Fields Screen has following information fields and menu options.

 

 

Srl

The serial number for the line.

 

Enable

Yes/No, Enforced only when set to Yes.

 

Field ID

Fields ID number.

 

FK Table ID

Foreign EM Table ID number.

 

FK Field ID

Foreign EM Table field ID number.

 

 

Table Properties

 

Use this screen to view and change EM Table Properties.

      

Note : These properties are at the central EM Table level and will be applied to all access routes to given table, i.e. via forms or no forms, and from all WebProject screens.

 

EM Table Classification Basics: They are categorized into 3 types and belong to one category at any given time as per settings and restrictions given below:

 

I) EM Table [DEF] (not linked to database)

 

·        This default category upon creation.

·        Clicking RDBMS Table (UnLink) on Table options menu will set this type and mark all fields Linked to RDBMS property to (Blank)=No.

·        All fields of the EM Table MUST have Linked to RDBMS set to (Blank)=No.

 

II) EM Table [LN] (linked to database)

 

·        Clicking Link RDBMS Table on Table options menu will set this type and mark all fields Linked to RDBMS property to Yes.

·        1st (First) field of the EM Table MUST have Linked to RDBMS set to Yes for this type to be valid. Subsequent fields can have Linked to RDBMS set to Yes or (Blank)=No, when later the table is treated as Mixed Table, Useful for customization of physical tables i.e. adding more fields.

·        If 1st (First) field of the EM Table has Linked to RDBMS set to (Blank)=No and any subsequent fields have Linked to RDBMS set to Yes, this is malformed definition and not supported.

 

III) EM Table [LN-DA] (Linked to database and marked for Direct Access)

 

·        After setting the table type to “EM Table [LN] (linked to database)” as described above and specify following:

·        Set Db Properties to DirectAccess or DirectAccessUsr.

 

 

Screen Snapshot: Table - Properties

 

Following is the detail description on the fields and information on Table properties screen.

 

Table Level Properties

 

Db Properties:

For a Linked Table, these properties define direct access to data in a physical table.

 

  • [Blank]: Indicates default normal mode with acces to tables using User Id and Record No.  i.e. the columns CL_USER and CL_VAL_ID.

 

  • DirectAccess: This option is used to access the data in physical table when not populated through EM AFE i.e. the columns CL_USER and CL_VAL_ID are by-passed. Useful for data warehousing type of applications. The User must be defined in conf param: “em.param.em_user_da”, to access tables directly.

 

  • DirectAccessUsr: This option is similar to “DirectAccess” except that user id is verified i.e. CL_USER is matched against present Inbox/App User Id. Useful to map user level data populated by other apps into EM AFE.

 

Db Ops Flags*: IERDACNHX O PGU:

This field stores database operation settings flags for the table , if any. They can define restriction at EM Table level on database operations. One or more flags can be set.

 

  • IERDANHX: Restrict Actions, where I=Input, E=Edit, R=Read, D=Delete, A=Archive, C=Copy, N=UnDelete, H=UnArchive, X=Linked Table Deleted Rec CleanUp (physical delete.)
  • O: Allow RecInfo (Data record Owner Info) changes.
  • PGU: LookUp Table Receiver flags, indicates ingore checks for, P=App User, G=Data Grp, U=User Id [Use LookUp User Id].

 

Note:

  • Scope of LookUp Table Receiver flags (PGU) limits to Table Data View (Query/ DisplayAll/ etc) and foreign key checks only. Table Data Edit, Copy, Update, Delete operations on received data will give errors as authorization will fail.
  • When using this mode, user must take care not to have records with same record nos as lookup table, in your own table i.e. maintain them unique across your and lookup table.

 

LookUp User Id:

Will use this substitute User ID to access data for the EM Table, when Db Ops Flag ‘U’ is set. LookUp User Id must be defined in conf param: “em.param.em_user_lkup” with authorization tokens for this table or all tables, for the data fetch to be successful.

 

Following 2 options are future provisions and will be implemented in next release:

  • Linked Tbl Db Prefix: Table prefix to be used for linked table.
  • EM Tbl Db Prefix: Table prefix set for EM Table by Administrator. For grouping of EM system tables.

 

 

Field Level Properties

 

 

Srl

Serial No.

 

Field Name [Field Id: Datatype: Length:Disp Len]

Field details.

 

Linked to RDBMS

(Blank)=No/Yes. Allows to selectively link or unlink some of the fields to database table. Note - For the EM Table to be treated as linked to database table first field MUST be linked i.e. “Yes”.

 

Db Prop

Used for now, for STREAM datatypes to define the type of JDBC stream to be opened (Ascii or Binary) during upload/download and optionally define Content-Type for download. Mis-match of actual datatype of column in database table and the setting here can cause problems. Default for STREAM is “Binary” with Content-Type not set for download.

Examples of usage:

Ascii

Binary

Ascii Content-Type: text/plain

Binary Content-Type: image/gif

Binary Content-Type: image/pjpeg

 

Db Ops Not Allowed: IER

This field defines restriction at field level on db operations. If 1 or more letters are set corresponding actions are disabled:

I=Input, E=Edit, R=Read

 

Key: Edit/Del Key for DirectAccess

To be implemented in future release.

(Blank)=No/Yes. When one or more columns is set to Yes, those column values will be used as key values in Edit/Del action.

 

Field Id

Reserved for future release.

 

 

 

Table Join (Data Copy/Update Table-to-Table)

 

Use this screen to view and define new EM Table Joins.

 

Define Table Join relationships:

  • To copy data from one EM Table to other.
  • To update multiple records data of an EM Table at one go.
  • To Join tables in query i.e. display join column matching data in WebProject DisplayCombined screens with query option: JoinQuery.
  • In workarounds to enforce EM keys.
  • In workarounds To issue EM Table level updates.

 

Some of the considerations are:

  • Table Data Copy:
    • If target table is EM Table - My Table (not linked), FILE datatype copy is disabled. Content Link info also is not copied.
    • If target table is EM Table – Linked, STREAM datatype copy is enabled.
  • Table Update:
    • Disabled datatypes: FILE

 

Screen Snapshot: See below.

Table Join (No Entries)
Table Join - Create Entry -Select Source Table
Table Join
Table Join - Edit (Define column join)
Table Join (after Edit)
Table Join - EditAdv (Advanced)
Table Join (after EditAdv)
Table Join - Data Copy Execute (Error)
Table Join - (Modified)
Table Join -Data Copy Execute (Again)

 

 

Table Join screen has following menu options and information fields.

 

 

Create New

Create new table join definition. After clicking this option a list of tables (with Table Name, Table ID #, Date Created) is displayed to select 2nd table for join.

 

 

 

 

Edit

Edit the definition. Only column to column match allowed.

 

EditAdv

Edit the definition - advanced. Allows setting pre-qual, and operator, value and end qual.

 

Del

Delete the definition.

 

 

 

 

Defn Id

Table-Join definition ID.

 

Target Table Name

Target Table for data copy.

 

 

 

 

Target Field Name

Field Name [Datatype:Length:Disp Len]

 

Qualifier Begin

Begin qualifier, Example: See below.

 

Source Field Name

Field Name [Datatype:Length:Disp Len]

 

Operator, Value, Qualifier End

Operator, Value or modifier ,Qualifier End

Example: See below.

 

Source Table Name

Source Table for data copy.

 

Query ID

Query Id No to be used on source table while fetching data for copy. Allows copying subset of data.

In case of Update the query is run on the target table and matching records updated.

 

 

 

 

Copy Data

Executes copy data operation and reports status at record level. Record No, Either record copied or any Errors (e.g. key violations).

 

ChkCpyRowsOnly

Find out number of rows affected in copy data operation but DO NOT actually copy them.

 

Update Table Options

Available Only When:

Source Table (Id) is same as Target Table (Id)

 

Update Target Table

Executes update data operation and reports status at record level. Record No, Either record copied or any Errors (e.g. key violations).

 

ChkUpdRowsOnly

Find out number of rows affected in update data operation but DO NOT actually copy them.

 

 

Note: The column joins for EM datatypes FILE, STREAM should be used with due care.

 

Examples for EditAdv, use of pre-qual, operator, value and end-qual:

 

  • upper(rpad(             “SOURCE FIELD”      ||”, Good Morning ! ”,60))

 

  • decode(                   “SOURCE FIELD”      ,0,’No’,1,’Yes’,’Unknown’)

 

  • to_char(                  “SOURCE FIELD”      ,’Mon-DD-YYYY’)

 

 

 

Advanced Table Join: Special EM Script

 

Advanced Table Join allow for processing of special EM Script code within Qualifier Begin, Value and Qualifier End strings. They will be processed in table join execute options. Following are available:

 

EM Script Code Syntax Conventions:

 

  • The EM special syntax is identified as tokens or statements which are included in “[{“ and “]}”. The order of square-curly brackets for begin and ending, is same not reverse, although non-consistent, is done on purpose to specially identify EM syntax.

 

 

Token

Description

 

[{FLD]}

Token is replaced by Actual Field (Name) i.e. Value. To use effectively the right side Field must be selected (can not be blank). Use for multiple occurrence of a column in expression.

 

 

 

 

[{TODAY]}

 

System current Date/Time expression.

 

[{NOW]}

 

System current Date/Time expression.

 

[{USRID]}

Token replaced with User ID.

 

[{USRSI]}

Token replaced with User ID of Sign-In User.

 

[{USRAS]}

Token replaced with User ID of As User.

 

[{USRDG]}

Token replaced with Data Grp.

 

Copy Data

 

 

[{UNQ]}

Token replaced with new Record Id No.

 

[{UNQOLD]}

Token replaced with Source Tables Record Id No.

 

Update Data

 

 

[{UNQ]}

Token replaced with Record Id No.

 

[{UNQOLD]}

Token replaced with Record Id No. Same as [{UNQ]}.

         

Following are some examples: The SQL syntax used is specific to MS Access database.

 

Example 1: Assign today’s date to a field.

 

Val: [{TODAY]}

 

Example 2: Give Salary raise of 20%.

 

Field: Salary [FLOAT:20:20]

Oper: +

Val: ([{FLD]} * 20/100 )

 

 

Data Options (No Form)

 

Use these options to invoke data actions like Input, View without any form, i.e. with system default for “no form” properties.

 

Data Ops (No Form):

 

Input Data (No Form)

  • Input the data to the EM Table. See details below.

 

For following options, please refer to corresponding actions (with form).

 

View Data – All (No Form)

  • View All records of the EM table.

 

New Query (No Form)

  • Construct a new query to retrieve data from EM Table using Query Screen. Query is always saved with a form number. For “no form” option form # 1 is used while saving.

 

Saved Queries For All Forms

  • Lists the previously saved queries for all forms.

 

 

Input/Edit Data (No Form)

 

Use this screen to input/edit data to an EM Table without using form.

 

  • EM Table properties, EM Keys are applied.
  • Uses default layout format and colors.
  • No form means no form restrictions are applied, all fields visible.
  • Useful in debugging problem forms.

 

  • Transactions, Data Consistency Handling: Input/Edit Data Form comprise of a transaction which spans actions like data insert, EM constraint verification (unique, foreign keys), and any SQLException Errors from database.

 

Screen Snapshot: Table - Input/Edit Data (No Form)

 

Input/Edit Data (no form) screen has following information fields and options.

 

 

Actual Table field Prompts and Data input boxes

Input Form displayed as per default layout. For Edit data record matching corresponding key is displayed.

 

 

 

 

Submit

Submit this record for Input/Edit.

 

Reset

Reset values on form.

 

 

Archive Data

 

Use this screen to view header info of, or Restore archived data records.

 

  • Archived records are completely cleared when EM System Administrator takes their backup and runs clean-up batch jobs and hence may not be available for Restore all the time.
  • Work with your EM System Administrator to restore any old archived records from back-ups.

 

Screen Snapshot: Table - Archived Data

 

Archive Data Screen has following information fields and options.

 

 

Restore ALL

Link to Restore ALL the Archived records.

 

For Each Archived Record:

 

 

Record #

Record ID number of archived record.

 

Data Grp

Data Grp

 

App User

App User who is owner of the record.

 

Last Chg By

Last Changed by User ID.

 

Archived

Date Archived.

 

 

 

 

Restore

Link to Restore this Archived record.

 

 

 

UnDelete Data

 

Use this screen to view header info of, or UnDelete deleted data records.

 

  • Deleted records are completely cleared when EM System Administrator runs clean-up batch jobs and hence may not be available for UnDelete all the time.

 

Screen Snapshot: Table - UnDelete Data

 

UnDelete Data Screen has following information fields and options.

 

 

UnDelete ALL

Link to UnDelete ALL the Deleted records.

 

For Each Deleted Record:

 

 

Record #

Record ID number of deleted record.

 

Data Grp

Data Grp

 

App User

App User who is owner of the record.

 

Last Chg By

Last Changed by User ID.

 

Deleted

Date Deleted.

 

 

 

 

UnDelete

Link to UnDelete this Deleted record.

 

 

Table Form: Edit

 

Use this screen to choose options to view or make changes to the form and or fields.

 

Screen Snapshot: WebForms - Edit

 

Table Forms: Edit

 

The Form Edit screen has 2 sections viz. Form Properties and Fields Level properties.

 

Table Forms: Edit: Form Properties Section

 

Form Properties Section has following information fields and menu options.

 

 

Preview Form

Preview the form for Input Data.

 

Copy Prop

Copy (Mark) properties of this form for subsequent Paste.

 

Make Default

Make properties of this form as Default Form Properties.

 

Form #

View/Edit Form level Properties (All)

 

Paste (All)

Paste properties (All) of the form earlier Copy (Marked).

 

Apply Default (All)

Apply Default Form Properties (All) to this form.

 

Form Properties: Sections

Has two (2) sections. Cosmetic and Advanced.

 

All

Cosmetic

Advanced

View/Edit Form level Properties : Selected section

 

Paste: Sections

 

 

All

Cosmetic

Advanced

Paste properties : Selected section: of the form earlier Copy (Marked).

 

Apply Default: Sections

 

 

All

Cosmetic

Advanced

Apply Default Form Properties : Selected section: to this form.

 

Edit Layout

 

 

Layout

View/Edit Layout for form type NormalLayout.

 

   

 

 

Table Forms: Edit: Field Properties Section

 

Field Properties Section has following information fields and menu options for each field in the Table.

 

 

Paste to ALL Fields

Paste Field Properties earlier Copy (Marked) to each field of this table.

 

All

Cosmetic InputEdit QryDisplay

Script

LookUp

Paste Field Properties earlier Copy (Marked): Selected section:  to each field of this table.

 

Apply Default to ALL Fields

Apply Default Field Properties to each field of this table.

 

All

Cosmetic InputEdit QryDisplay

Script

LookUp

Apply Default Field Properties: Selected section:  to each field of this table.

 

 

 

 

Field Order

Order of the field on WebForms, query wizard.

 

Field Name

View/Edit field properties (All) for this field.

 

Copy

Copy (Mark) properties (All) of this field for subsequent Paste.

 

Make Default

Make properties (All) of this field as Default Field Properties.

 

Field ID

Fields ID number.

 

Field SQL ID

Fields SQL column name in database table.

 

Data Type

EM Datatype of the field. 

 

Size

The maximum size of the field.

 

Display Size

The size to be displayed on screen.

 

 

 

 

Field Properties: Sections

 

 

All

Cosmetic InputEdit QryDisplay

Script

LookUp

View/Edit field properties : Selected section: for this field.

 

Paste: Sections

 

 

All

Cosmetic InputEdit QryDisplay

Script

LookUp

Paste Field Properties earlier Copy (Marked): Selected section:  to this field.

 

Apply Default: Sections

 

 

All

Cosmetic InputEdit QryDisplay

Script

LookUp

Apply Default Field Properties : Selected section:  to this field.

 

 

 

Table Form: Edit : Form Properties

 

Use this screen to view or make changes to the form level properties.

 

Screen Snapshot: WebForms - Form Properties

 

WebForms: Edit : Form Properties

 

Form Level Properties Screen has following information fields and menu options.

 

 

Form Properties: Cosmetic

 

 

Orientation

One of following

  • Normal : Default, standard format.

·        NormalLayout: Uses Layout definition rather than standard.

  • Tabular: Spreadsheet style horizontal records.
  • TabularNoHeader: Tabular with no Record Info like User, Data Grp, etc.

 

 

Notes on Using Orientation property:

Input/Edit and Display Forms:

·        NormalLayout: Uses Layout definition rather than standard.

Input/Edit Forms:

  • Normal/Tabular/TabularNoHeader: Default, standard format. Tabular useful for Display Forms only.

Display Forms:

  • Normal: Default, standard format.
  • Tabular: Spreadsheet style horizontal records.
  • TabularNoHeader: Tabular with no Record Info like User, Data Grp, etc.

 

 

Following 5 fields values are used in HTML table tag generated for data records:

 

Border

One of: 0,1,2,3. Sets border=”n” in HTML table tag.

 

Form Width %

Sets width=”nn%” in HTML table tag.

 

Background Color

Sets bgcolor=”xxxx” in HTML table tag.

 

Field Spacing

Sets cellspacing=”nn” in HTML table tag.

 

Field Padding

Sets cellpadding=”nn” in HTML table tag.

 

 

 

 

Submit Button Label

Label for Submit Button in Input/Edit Mode. If left blank “Submit” is used.

 

 

 

 

Form Properties: Advanced

 

 

Info

Form user defined info string.

 

Status

User defined form status.

 

Enable Script ?

No/Yes. If yes, the Script code added to form.

Please refer to “EM Script Code Processing” for more details.

 

Script Code (Upto 2000 char) / FreeStyle HTML code:

Script Code. JavaScript is commonly used. For Example:

<SCRIPT language=”JavaScript”>

function chkVal() {

// function code here…

}

document.forms[0].onsubmit = chkVal();

</SCRIPT>

 

 

 

 

SQL Post Process?

(NA For Display Mode)

No/”Option”. Default No. Enable Table Form level post process trigger as specified. See detailed description below.

 

Script Code (Upto 2000 char):

Actual SQL Post Process Code. See Notes below.

 

 

SQL Post Process?: The field if not set to “No”, determines when, i.e. after which action input, edit, delete or archive or combinations thereof, the associated code is applied.

 

One of:

  • Input, Edit, Del, Arc
  • Or the character combinations for multiple associations as indicated below:
  • I---, IE--, I-D-, I--A, IED-, IE-A, I-DA, IEDA, -E--, -ED-, -E-A, -EDA, --D-, --DA, ---A

 

Script Code Syntax Conventions:

 

  • The SQL Post Process uses special syntax along with SQL syntax applicable to the database being used.
  • The EM special syntax is identified as tokens or statements which are included in “[{“ and “]}”. The order of square-curly brackets for begin and ending, is same not reverse, although non-consistent, is done on purpose to specially identify EM syntax.

 

 

 

Token

Description

 

 

 

 

For All Users:

 

 

 

 

 

[{NO-<I|E|D|R>]}

 

For example:

[{NO-E]}

[{NO-D]}[{NO-I]}

 

No Input/Edit/Del/Read, means disable the specified action. Example if used:

[{NO-E]}

Then after Edit Form Submit following error is displayed:

[App Error: Action U is Disabled.]

Multiple actions, use separate tokens as in:

[{NO-D]}[{NO-I]}

 

 

 

 

[{UNQ]}

Token replaced with Record ID number.

 

[{USRID]}

Token replaced with User ID.

 

[{USRSI]}

Token replaced with User ID of Sign-In User.

 

[{USRAS]}

Token replaced with User ID of As User.

 

[{USRDG]}

Token replaced with Data Grp.

 

 

 

 

For Advanced Users:

 

 

 

 

 

[{SQLS<...>SQLS]}

SQL Statements, SELECT value checked, if 1 ok, else Fail return Error.

 

[{SQLC<...>SQLC]}

SQL condition used in WHERE clause, if true returns 1 ok, else Fail return Error

 

[{SQLF<...>SQLF]}

SQL code/function, return value checked, if 1 ok, else Fail return Error

 

[{SQLP<...>SQLP]}

SQL code/procedure executed, no return value checked, but if SQLException then Fail return Error

 

 

 

 

[{MSG<…>MSG]}

App Error Message to be reported. Is Nested token for [{SQL_<…>SQL_]} only, else not processed.

 

 

 

         

 

Following are some examples of SQL post process. The SQL syntax used is specific to Oracle database.

 

Example 1: Edit is disabled and on Delete SQLF i.e. function is called, if return 0 then App Error is reported.

 

[{NO-E]}

[{SQLF EMF_VALID_DT('02/02/2002') [{ON-D]} [{MSG Delete did not go thru! MSG]} SQLF]}

 

Example 2: On Archive SQLP i.e. procedure is called with record ID as parameter.

 

[{SQLP     chk_arch_ok([{UNQ]})      [{ON-A]} SQLP]}

 

Example 3: On Edit SQLS i.e. statement is called.

 

[{SQLS select 1 from dual [{ON-E]} SQLS]}

 

Example 4: On Input SQLC i.e. WHERE condition is checked.

 

[{SQLC '[{USRSI]}' in ('TEST55','TEST44') [{ON-I]} [{MSG User must be TEST55 Or TEST44! MSG]} SQLC]}

 

 

 

Table Form: Edit : Form Layout

 

Use this screen to view or make changes to the form layout used by “NormalLayout” orientation.

 

Screen Snapshot: WebForms - Form Layout

 

WebForms: Edit : Form Layout

 

When designing layout consider following:

 

  • The Layout definition is only used when Form Orientation is set to “NormalLayout”.
  • The EM Layout uses HTML table as basis for positioning each field prompt and data.
  • By default the layout is like “Normal”, 2 columns, each field on separate row having prompt on left and data on right column.
  • To define the layout for the first time, let’s first consider the layout of HTML table as No Of Columns x No Of Rows on a piece of paper. Then position each field’s prompt and data parts, each into one or more columns horizontally without overlapping. Complete the exercise for all the fields. Now in browser form, put the Row No as Line No, Column From and To values into respective parts. See the display and make any more changes to achieve desired output.
  • Ignore the Field prompts and Data which are set Hide=Yes in field properties. They are displayed on the screen but are filtered on form generation.
  • Missing Line Nos before Line no of last field prompt or data are displayed as blank line on form. Column of left side of a prompt or data can not be left un-assigned.
  • Custom free style HTML tags added to field properties give you more power for design including multi-row spanning of a column.

 

Form Layout Screen has following information fields and menu options.

 

 

No

Serial No

 

Field

Field Name

 

Datatype

Field’s datatype

 

Size

Field’s Size

 

Display Size

Field’s Display Size

 

 

 

 

Prompt

 

 

Line

Line No

 

Column From

Starting column no

 

Column To

Ending column no

 

 

 

 

Data

 

 

Line

Line No

 

Column From

Starting column no

 

Column To

Ending column no

 

 

 

 

One Click Layout Options

Provided to quickly transform the layout to selected option, will change all the fields and will clear out previous values.

 

Normal

Line 1: Field Prompt | Data Value

 

Tabular

Spreadsheet style.

 

Alt. Line

Line 1: Field Prompt

Line 2: Data Value

 

2 Columns

Line 1: Field 1 Prompt | 1 Data Value | Field 2 Prompt | 2 Data Value

 

3 Columns

Line 1: Field 1 Prompt | 1 Data Value | Field 2 Prompt | 2 Data Value | Field 3 Prompt | 3 Data Value

 

 

Example 1: Default Layout, like that of “Normal” orientation.

 

Layout form filled-up as below:

 

 

 

Prompt

 

 

Data

 

 

Srl

Field

Line

Column From

Column To

Line

Column From

Column To

1

Name

1

1

1

1

2

2

2

Address Line 1

2

1

1

2

2

2

3

Address Line 2

3

1

1

3

2

2

4

City

4

1

1

4

2

2

5

State

5

1

1

5

2

2

6

Country

6

1

1

6

2

2

7

Telephone

7

1

1

7

2

2

8

Fax

8

1

1

8

2

2

9

Email

9

1

1

9

2

2

 

Example 2: Layout with 4 columns, Name, Address Line 1 & 2 (data spread over 3 columns); City & State on 1 line, Country & Email on 1 line, Line No 6 left blank, Telephone & Fax (Data on next line below prompt).

 

Layout should look like this:

Name

[Name Data]

Address Line 1

[Address Line 1 Data]

Address Line 2

[Address Line 2 Data]

City

[City Data]

State

[State Data]

Country

[Country Data]

Email

[Email Data]

 

Telephone

Fax

[Telephone Data]

[Fax Data]

 

 

Layout form fill-up as below:

 

 

Prompt

 

 

Data

 

 

Srl

Field

Line

Column From

Column To

Line

Column From

Column To

1

Name

1

1

1

1

2

4

2

Address Line 1

2

1

1

2

2

4

3

Address Line 2

3

1

1

3

2

4

4

City

4

1

1

4

2

2

5

State

4

3

3

4

4

4

6

Country

5

1

1

5

2

2

7

Telephone

7

1

2

8

1

2

8

Fax

7

3

4

8

3

4

9

Email

5

3

3

5

4

4

 

 

Table Forms: Edit : Field Properties

 

Use this screen to view or make changes to the field level properties.

 

Screen Snapshot: WebForms - Field Properties

 

WebForms: Edit : Field Properties

 

Field Level Properties Screen has following information fields and menu options.

 

Field Properties: Cosmetic

 

 

Positioning:

 

 

Normal Orientation - Blank Lines Before

Number of blank lines (rows) to be added before this field row.

 

Tabular Orientation –

Field Width %

Column width in case of Tabular format. Used in HTML td tag: width=”nn”%

 

 

 

 

Field Prompt Properties

 

 

Bold

No/Yes.

 

Italics

No/Yes.

 

Under line

No/Yes.

 

Background Color

One of color name or Hex code. Examples: Yellow, Pink, #DEDEDE, #FFFFAC

 

Font Face

Name of 1 or more fonts separated by commas. Example: Verdana, Arial

 

Font Size

Size of font: One of 1,2,3,4

 

Font Color

One of color name or Hex code. Examples: Blue, Green, #0000FF

 

Alignment

One Of: Left, Center, Right

 

Vertical Alignment

One Of: Top, Center, Bottom

 

No Word Wrap

No/Yes.

 

Hide

No/Yes.

 

         

 

 

FreeStyle HTML code ?

One of: No/Befor/After

If Set to Befor or After then HTML text in next field is displayed Before or After the prompt of field.

Please refer to “EM Script Code Processing” for more details.

 

HTML text (Upto 2000 char):

HTML text.

 

 

 

 

Data Display Properties

 

 

Bold

No/Yes.

 

Italics

No/Yes.

 

Under line

No/Yes.

 

Background Color

One of color name or Hex code. Examples: Yellow, Pink, #DEDEDE, #FFFFAC

 

Font Face

Name of 1 or more fonts separated by commas. Example: Verdana, Arial

 

Font Size

Size of font: One of 1,2,3,4

 

Font Color

One of color name or Hex code. Examples: Blue, Green, #0000FF

 

Alignment

One Of: Left, Center, Right

 

Vertical Alignment

One Of: Top, Center, Bottom

 

No Word Wrap

No/Yes.

 

Hide

No/Yes.

 

         

 

 

FreeStyle HTML code ?

One of: No/Befor/After

If Set to Befor or After then HTML text in next field is displayed Before or After the data part of field.

Please refer to “EM Script Code Processing” for more details.

 

HTML text (Upto 2000 char):

HTML text.

 

 

Business Logic Properties:

 

 

 

Field Properties: InputEdit

 

 

Data Input Validation     

 

 

Input Mandatory

No/Yes. If Yes value must be entered on Input/Edit. Blank space allowed as value. To disable blank space, use Min Len.

 

Minimum Length(Characters)

One of: 0 – 11, When set to non-zero, input must match the length (excluding blanks).

 

Default Value

Any default value for field to be used in Input Mode.

 

Allowed Values (Comma Separated)

If specified, drop-down selection will be made available from these values on field input/edit.

 

HTML Object

Other than Blank value, the HTML object is used instead of input tag in Input/Edit Mode OR constructs a special object in Display Mode.

 

Usage of HTML Object is explained in a section below.

 

 

Object Properties

Usage of HTML Object properties is explained in a section below.

 

 

Display Only On ?

One Of: Blank, Input, Edit, Both

When not blank, makes field data “display only” in specified mode.

 

Field Datatype/Format help on Input Form

One Of: Blank, None, Format, FormatDatatype, Datatype.

Blank = None: Nothing displayed.

FormatDatatype: Displays “Format” and “Datatype” both as below.

Format: Displays date & time formats e.g. MM/DD/YYYY.

Datatype: Displays datatype e.g. [CHAR]

 

Post-Process ?

One Of: No, Input, Edit, Both.

Default No. Enable Table Field level post process trigger as specified. See detailed description below.

 

EM Script/Formula

Actual SQL Post Process Code, Formula, etc. See Notes below.

 

Field Properties: QryDisplay

 

 

Query Form

 

 

Style  

Helps to customize display and options on Query Form.

One Of: Blank, InputValue, MultiValue, MultiValueSelect, MultiValueAny, Default

Blank = Default = InputValue (Multi-field dropdown)

InputValue = One Field, Input box

MultiValue = One Field, DropDown Box of Allowed values.

MultiValueSelect = Same MultiValue above with top entry as “Select One”

MultiValueAny = Same as MultiValue with top entry as “Match Any”

 

When one of the field is non-blank then fields with blank Style are ignored from query wizard.

 

                   

 

 

Data Display Modifier

 

 

Apply

No/Yes. Default No. If Yes, In Display Mode, modify the field SELECT clause in SQL query as specified. See detailed description below.

 

EM Script/Formula (Upto 1000 char)

Actual EM Script, SQL Code, Formula, etc. See Notes below.

 

Field Properties: Script

InputEdit

 

 

Script

 

 

Enable Script ?

No/Yes. If yes, the Script code text added to form.

Please refer to “EM Script Code Processing” for more details.

 

Script Code (Upto 2000 char):

Script Code. JavaScript is supported at present. For Example:

<SCRIPT language=”JavaScript”>

function chkValFldF10350() {

// function code…

}

</SCRIPT>

Note: To call functions from input fields, etc, e.g. OnClick=” chkValFldF10350();”, use a javascript as:

Document.forms[0].F10350.onclick = func_name;

 

 

Other Properties:

 

 

Field Properties: LookUp

 

 

Look Up Table Field

 

 

Enable Look Up ?

No/Yes. If Yes, a “Look-Up” Link option is displayed in Input/Edit Mode. Upon clicking will display pop-up look-up table window. The features of look-up are that of a WebProject which can consist of pre-defined form, with open or pre-defined query, 1 or more screens, etc.

 

WebProject Id

Look-Up Screen’s WebPorject ID number.

 

Screen Order

Screen Order Number. Example: 1,2,3

 

Field Id

Corresponding Look-Up table form field ID number to fetch back data. On Look-Up pop-up windows, a select “Ok” button is displayed against this field to fetch back the look-up value.

Note: Use of field id with following data types is NOT supported for fetch-back:

TEXT, TEXTS, HYPERLINK, STREAM, FILE

 

 

Using HTML Object type:

 

Other than Blank value, the HTML object is used instead of input tag in Input/Edit Mode OR constructs a special object in Display Mode.

 

Values can be One Of:

Blank

CheckBox

RadioButton

DropDownBox

DateObjPicker

ObjFileImage

ObjFileImageInfo

ObjVideoFlash

ObjVideoMplayer2

ObjVideoHtml5

ObjAudioHtml5

ObjEmbedHtml5

ObjInsFrame

ObjHtmlObject

TextObjHtmlSafe

TextObjCode

TextObjHtmlObject

 

 

When is HTML Object processed? :

HTML Object value is processed as per following conditions matching:

 

Mode

Applicable TO Data Types

Values

Purpose / Comments

All

All

Blank

 

No special HTML Object

 

 

 

 

Input / Edit

CHAR, NUMBER, MONEY, FLOAT, DATE, DATETIME, TIME, BOOLEAN

 

 

 

 

CheckBox

Display CheckBox, Use “Default Value” as checked value.

 

 

RadioButton

Display Radio Buttons, Use “Allowed Values (Comma Separated)” as multiple values.

 

 

DropDownBox

Display Drop Down Box, Use “Allowed Values (Comma Separated)” as multiple values.

Input / Edit

DATE

DateObjPicker

OnClick Display Date Picker pop-up, Will display calendar created with current value in field. On selecting a date from calendar, the value will be filled back into field.

 

For Date Picker, The date format is fixed at present to:

YYYY-MM-DD

 

So For EM “Date format - Input:” must match accordingly defined on “Options: Update User Profile” screen.

 

For MySQL Db define “Date format - Input:” as per 5 values below :

%Y - %m - %d

 

NOTE: EM “Date format - Display:” can be any format as per user choice.

 

 

 

 

 

Input / Edit

TEXT, TEXTS

TextObjHtmlSafe

TextObjHtmlObject

Input/Edit Mode Display Text HTML Editor for input.

 

 

 

 

Display

TEXT, TEXTS

 

 

 

 

TextObjHtmlSafe

Display TEXT data as HTML with Safe Tags allowed, rest disabled.

 

 

TextObjCode

Display TEXT data as computer code / source  with Tags disabled and wrapped in <code> </code> tag.

 

 

TextObjHtmlObject

Display TEXT data as HTML with All Tags allowed, as per conf. param setting level.

 

 

 

Note: Object Properties field values are not used for TextObj… Display Mode.

 

 

 

NOTE: For information on Display of HTML Tag Restrinctions, please refer to “HTML Tag Restrinctions”.

Display

HYPERLINK,  FILE, STREAM

ObjFileImage

ObjFileImageInfo

ObjVideoFlash

ObjVideoMplayer2

ObjVideoHtml5

ObjAudioHtml5

ObjEmbedHtml5

ObjInsFrame

ObjHtmlObject

See detailed section below.

 

 

 

 

 

 

Using HTML Object Properties:

 

Additional HTML Object tag attributes to previous field. Examples:

For DropDownBox ŕ

size=10 multiple

For ObjFileImage ŕ

height=200 width=200 border=1

For ObjFileImageInfo ŕ

border=1 height=100 width=100

 

For ObjXxxxxx  ŕ

height=100 width=100

 

 

Using HTML Object types “Obj…”

 

For ObjFileImage, the image is displayed using IMAGE tag in Display Mode. For ObjFileImageInfo, the image, image info and link to upload/download is added too.

 

 

  • Following HTML Object types (i.e. “Obj…”) can be used for HYPERLINK or FILE/STREAM data types only. If used for other types then ignored.
  • HTML Object types are enabled if the “em.param.em_disp_htmlObj” conf param is set to appropriate value, else ignored. Please see em_param_en_US.properties file for details.
  • URL mentioned below is derived from HYPERLINK URL part or FILE Download link URL.

 

Usage of HTML Object types:

  • ObjFileImage : To display picture/image with <IMG src=URL> tag.
  • ObjFileImageInfo : To display picture/image with <IMG src=URL> tag. And display FILE info link to Download/Upload.
  • ObjVideoFlash : To display video with Adobe Flash (e.g. *.swf).
    • Uses <object> with <embed> tag with property “type=application/x-shockwave-flash".
  • ObjVideoMplayer2 : To display video with Windows Media Player.
    • Uses <object> with <embed> tag with property “type=application/x-mplayer2".
  • ObjVideoHtml5 : To display video with HTML5 <video src=URL> tag.
  • ObjAudioHtml5 : To play audio with HTML5 <audio src=URL> tag.
  • ObjEmbedHtml5 : To use HTML5 <embed src=URL> tag.
  • ObjInsFrame : To insert frame with <iframe src=URL> tag.
  • ObjHtmlObject : To use HTML <object data=URL> tag.

 

 

Using Post Process:

 

Post Process?: The field if not set to “No”, determines when, i.e. after which action input, edit, or both, the associated post process EM Script code is applied.

 

  • The Post Process is not applied to EM datatypes: BOOLEAN, FILE, STREAM, i.e. it is ignored even if set for these datatypes.
  • The Post process is not applied to Display or Query Mode.

 

EM Script Code Syntax Conventions:

 

  • The SQL Post Process uses special syntax along with SQL syntax applicable to the database being used.
  • The EM special syntax is identified as tokens or statements which are included in “[{“ and “]}”. The order of square-curly brackets for begin and ending, is same not reverse, although non-consistent, is done on purpose to specially identify EM syntax.

 

 

 

Token

Description

 

 

 

 

For All Users:

 

 

 

 

 

[{NOVAL]}

If this token is used, Data Value on Input/Edit form is ignored, only post process generated value if any is used.

 

[{VAL]}

Token is replaced by Actual Data Value on Input/Edit form, if [{VAL]} is not used then the formvalue is placed in beginning except when [{NOVAL]} is used, then the formvalue is ignored.

 

 

 

 

[{IC]}

 

* Oracle Only.

Convert the data to Init Capitals. Example:

“MR XYZ abc” ŕ “Mr Xyz Abc”

 

[{LC]}

 

Convert the data to Lower Case. Example:

“MR XYZ abc” ŕ “mr xyz abc”

 

[{UC]}

 

Convert the data to Upper Case. Example:

“MR XYZ abc” ŕ “MR XYZ ABC”

 

[{PAD<LT-|RT->10-**-PAD]}

 

* Oracle Only.

Pad the data as specified. Example:

PADLT-10-**-PAD

“MR XYZ” ŕ “****MR XYZ”

PADRT-10-@!-PAD

“MR XYZ” ŕ “MR XYZ@!@!”

Note: You can also Use free-style SQL statement with rpad(, lpad( instead.

 

 

 

 

[{DT-<YYMMDD...>-DT]}

Token replaced with Date in specified flexible format as understood by database.

Oracle e.g.: [{DT-MMDDYY-]}

Access e.g.: [{DT-mmddyyyy-]}

MS SQL Server use date format numbers like 101, 109 e.g. [{DT-101-DT]}

 

[{DT-<D|I>-<D|DT|T>-DT]}

Token replaced with Date in specified EM date default formats i.e. Date <Display|Input> Format For <Date|Datetime|Time>.

 

 

 

 

[{UNQ]}

Token replaced with Record ID number.

 

[{USRID]}

Token replaced with User ID.

 

[{USRSI]}

Token replaced with User ID of Sign-In User.

 

[{USRAS]}

Token replaced with User ID of As User.

 

[{USRDG]}

Token replaced with Data Grp.

 

 

 

 

 

 

 

For Advanced Users:

 

 

 

 

 

 

 

 

[{SQL<...>SQL]}

 

 

SQL Statements, SELECT value used as new generated value and replaced with [{SQL<…>SQL]} tokens.

 

 

 

 

[{SQLC<...>SQLC]}

SQL condition used in WHERE clause, to validate the data value or any other condition, if true returns 1 ok, else Fail return App Error

 

 

 

 

[{MSG<…>MSG]}

App Error Message to be reported. Is Nested token for [{SQLC<…>SQLC]} only, else not processed.

 

 

 

 

 

Note: [{DVAL]}, [{DTVAL]}, [{TVAL]} are nested tokens for [{SQL_<…>SQL_]} only, else not processed.

 

[{DVAL]}

Token is replaced by Actual Data Value on Input/Edit form with SQL DATE input format wrapper.

 

[{DTVAL]}

Token is replaced by Actual Data Value on Input/Edit form with SQL DATETIME input format wrapper.

 

[{TVAL]}

Token is replaced by Actual Data Value on Input/Edit form with SQL TIME input format wrapper.

 

 

 

         

 

Following are some examples of SQL post process. The SQL syntax used is specific to Oracle database.

 

Example 1: Assign Unique Number to a column. Achieved by making the data field “Display Only” on Input/Edit and enabling following post process code for Input.

 

[{NOVAL]}[{UNQ]}

 

 

Example 2: Change the data entered to upper case. Achieved by enabling following post process code for Both (Input/Edit).

 

[{UC]}

 

Example 3: Add “Hello Mr.” To the data entered, make it Init Cap. Error out if total length of input string is > 60 chars with message “Input Data Length must be 60 or less! ” Achieved by enabling following post process code for Both (Input/Edit).

 

[{IC]} [{SQL ‘Hello Mr.’ || [{VAL]} SQL]} [{SQLC vsize([{VAL]}) <= 60 [{MSG Input Data Length must be 60 or less! MSG]} SQLC]}

 

 

Example 4: A SQL function is called which will process the entered value date and generate a new expiry date.

 

[{SQL     chkval123_cal_expiry([{DVAL]})   SQL]}

 

Example 5: On Input SQLC i.e. WHERE condition is checked against input val.

 

[{SQLC '[{VAL]}' in ('CREDITCARD','BANKERCHECK') [{MSG Payment method must be Credit Card or Banker’s Check ! MSG]} SQLC]}

 

 

 

Data Display Modifier:

 

  • Apply ? : The field if set to “Yes”,  the associated EM Script code is applied in Display Mode to SQL SELECT clause of the field.
  • The Data Display Modifier is not applied to Input/Edit Mode.
  • The Data Display Modifier is not applied to EM datatypes: STREAM, as STREAM data is not selected on the form itself (except as in ObjFileImage).
  • The Data Display Modifier For EM datatypes: FILE is applied to “File Info” part only.

 

EM Script Code Syntax Conventions:

 

  • The SQL Post Process uses special syntax along with SQL syntax applicable to the database being used.
  • The EM special syntax is identified as tokens or statements which are included in “[{“ and “]}”. The order of square-curly brackets for begin and ending, is same not reverse, although non-consistent, is done on purpose to specially identify EM syntax.

 

 

 

Token

Description

 

 

 

 

For Advanced Users:

 

 

 

 

 

[{NOVAL]}

If this token is used, Field Data Value is ignored, a NULL is returned instead.

 

[{VAL]}

 

Token Can be used 1 or more times.

Token is replaced by Field Column Name, if [{VAL]} is not used then the column name is placed in beginning except when [{NOVAL]} is used, then NULL is returned.

 

 

 

 

SQL SELECT clause expression

 

 

Any SQL SELECT clause expression valid for the database.

         

 

Following are some examples of Data Display Modifier. The SQL syntax used is specific to Oracle database.

 

Example 1: Do not display actual value in column.

 

[{NOVAL]}

 

Example 2: Display data twice, as Upper case and lower case equivalents.

 

upper([{VAL]}) || ‘ <-- upper case : lower case --> ’ ||lower ([{VAL]})

 

Example 3: Format the number to a specific format.

 

to_char([{VAL]}, ’99,999,000.00’)

 

Example 4: Use decode function to display priority levels.

 

decode([{VAL]}, 1, ’High’, 2, ’Medium’, 3, ’Low’, ’Don’’t Care’)

 

 

 

Data Options using Forms

 

Use these options to invoke data actions like Input, View through forms, where Form properties are in effect.

 

Data Ops using Form:

 

Input Data

  • Input the data to the EM Table.

 

View Data - All

  • View All records of the EM table.

 

XML

  • View All records of the EM table formatted as XML file.

 

New Query

  • Construct a new query to retrieve data from EM Table using Query Form. See Enter Query Form below.

 

Saved Queries

  • Lists the previously saved queries using this form.

 

 

 

Saved Queries

 

Use this screen to view saved queries and invoke saved query options like Run, Query & DELETE, etc.

 

Screen Snapshot: Table - Saved Queries (Form)

 

Saved Query Considerations:

 

  • When displayed in Application, the saved queries are listed as per authorization level: Yours only or Groups.
  • Also the data records affected by query can be different as per authorization level.

 

Saved Query Screen has following information fields and options.

 

 

Query #

Query ID number.

 

Del

Delete this query.

 

Form #

Form ID number.

 

App User

App (Sign-In) User who saved the query.

 

Info [Data Grp, Created]

Data Grp, Date Created.

 

Query & DELETE

Run the query and DELETE matching records. Verifies any EM foreign key constraints and reports errors.

 

Query & ARCHIVE

Run the query and ARCHIVE matching records. Verifies any EM foreign key constraints and reports errors.

 

Query Details

Field Name, operator, query value, Ignore Case, Sort by, Sort Order, Limit Rows.

 

Run Query

Run the query and display matching records.

 

XML

Run the query and display matching records formatted as XML file using some of the form properties e.g. ‘Hide’.

 

MarkSend

Mark the EM Table object for EM Mail Compose (as Object, with the form id and query id).

 

 

New Query: Enter Query Details

 

Use this screen to enter details for and formulate new query on EM Table.

 

Screen Snapshot: Table - New Query (Form)

 

Queries can be simple or advanced using expressions.

 

Simple Queries

 

Considerations while formulating new simple Query:

 

Operator Help:

=      Equals

Like   Matches (Use with wildcard char %)

<      Less than

>      Greater than

<=     Less than or Equals

>=     Greater than or Equals

<>     Not Equals

Not Like    Does Not Match (Use with wildcard char %)

Is Null    Has No Value

Is Not Null    Has some Value

 

Using combinations:

- To search a numeric value falling in a range use <= end_value on one line AND >= begin_value on second line.

- To search for text having words "engineer" or "QA" but not "support" use:

      Fld1 Like %engineer%

   AND Fld1 Like %QA%

   AND Fld1 Not Like %support%

 

Usage Notes:

 

  1. Ignore Case 'Yes' means Query Search is case insensitive; applies to datatypes: CHAR, TEXTS, HYPERLINK, FILE (File Info).
  2. With operators 'Like' and 'Not Like' matching values can be searched (wild card search); using percent character (%) where required, e.g. To search all values having 'Id' in them, use %Id%
  3. Query values for DATE/DATETIME/TIME should be entered in respective input formats defined by profile in effect.
  4. For HYPERLINK datatype supported Operators are 'Like' and 'Not Like'.
  5. For STREAM datatype supported Operators are:'Is Null', 'Is Not Null'. Use of any other operators will be replaced by 'Is Not Null'.
  6. For Oracle Only: For TEXT datatype supported Operators are:'Is Null', 'Is Not Null'. Use of any other operators will be replaced by 'Is Not Null'.
  7. For FILE datatype search and Sort By/Order is done on file name and Size info and not on actual data file or BLOB.
  8. Sort By/Order NOT supported for datatypes TEXT/STREAM and is ignored.
  9. For TIME datatype Sort Order is supported, as per underlying default date policy of database vendor.
  10. Avoid using following 2 words at the same time in query value: ‘select’ and ‘from’.

 

Enter Query Details Screen has following information fields and options.

 

 

Apply

CheckBox if checked = Yes, then the query line is considered.

 

And/Or

One Of: AND, OR

Used to join this line with previous line using either “AND” or “OR” logic. For first line it is not required.

 

Field Name [Datatype]

Field name and datatype.

 

Operator

Relational Operator.

 

Ignore Case

No/Yes, Whether query should ignore case while retrieving matching records.

 

Query Value

Value to be queried.

Either Input or Select from DropDown.

 

Sort By

Sort the records by this field.

 

Sort Order

Use this order for sorting. Blank will default to database default sorting order (usually ascending).

 

Limit Rows

* Oracle Only

Limit the matching records retrieved to this number.

 

 

Using Non-Field Criteria in Query

 

This section has following information fields and options:

 

·        Non-Field Criteria

·        Check Data Group/App User/Modified By: Drop-down One of: “--Do Not Check--”, (Any Below), Data Group, App User, Modified By

·        Check Dates: Drop-down One of: “--Do Not Check--”, Created Or Updated, Created, Updated. Searches for EM Object created or updated dates.

·        Between Date 1: Begin date for check dates. Blank Defaults to Now.

·        Between Date 2: End date for check dates. Should be greater than or equal to begin date to yield results. Blank Defaults to Now.

·        OR, : Click this box to ignore between dates but use “within last days” parameter.

·        Within Last nn Days: Number of days before today to search from.

 

·        Sort By Non-Field Criteria: One of: “—No—“, Id, Created, Updated. Where: Id = EM Object Id, Created = EM Object Created date, Updated = EM Object updated date. If Sort By is specified, Results will be sorted on that particular field. This will ignore field level sort criteria , if any.

·        Sort Order: One of: (Blank), Ascending, Descending

 

·        *Date Input Format: [applicable date input format e.g. mm/dd/yyyy hh:nn AM/PM], Blank = Now 

 

 

Advanced Queries

 

Advanced queries allow for processing of expressions within query values.  You can enter special EM Script code and symbols or expressions (with SQL syntax applicable to the database being used) in the Query value. They will be processed in the query. Following are available:

 

EM Script Code Syntax Conventions:

 

  • The EM special syntax is identified as tokens or statements which are included in “[{“ and “]}”. The order of square-curly brackets for begin and ending, is same not reverse, although non-consistent, is done on purpose to specially identify EM syntax.

 

 

Token

Description

 

 

 

 

For Advanced Users:

 

 

 

 

 

[{EXPR]}

Treat the Query Value as expression. This will not wrap values with quotes for char types.

 

[{FLD]}

Token is replaced by Actual Field (Name) i.e. Value in query.

 

 

 

 

[{TODAY]}

 

System current Date/Time expression.

 

[{NOW]}

 

System current Date/Time expression.

 

[{USRID]}

Token replaced with User ID.

 

[{USRSI]}

Token replaced with User ID of Sign-In User.

 

[{USRAS]}

Token replaced with User ID of As User.

 

[{USRDG]}

Token replaced with Data Grp.

 

 

 

         

 

Following are some examples of Advanced Query: The SQL syntax used is specific to MS Access database.

 

Example 1: Find out purchase orders entered today.

 

Operator: =

Query Value: [{TODAY]}

 

Example 2: Find out records where salary field has value and Salary raise of 20% would be more than 2000.

 

Operator: Is Not Null

Query Value: AND [{FLD]} * 20/100 > 2000

 

Example 3: Find out records with matching values among a set of values.

 

Operator: Is Not Null

Query Value: AND [{FLD]} in (’White’,’Blue’,’Red’)

 

 

 

View All (Data) (Form)

 

Use this screen to view data in EM Table through a form.

 

  • The data records displayed can be different as per authorization level of user, when running App.

 

Screen Snapshot: Table - View All Data (Form)

 

View Data screen has following information fields and options.

 

 

If displayed after enter query:

 

 

Query Info

Query info string.

 

Save Query

Link to Save the query.

 

 

 

 

Record Information

Serial No, Record Id number, Data Grp, App User, Last Changed ‘Date/By’

 

 

 

 

Edit

Link to Edit this record.

 

Delete

Link to Delete this record. Confirmation screen displayed. Verifies any EM foreign key constraints and reports errors.

 

Archive

Link to Archive this record. Confirmation screen displayed. Verifies any EM foreign key constraints and reports errors.

 

Copy

Link to Copy this record. NO Confirmation screen displayed. Verifies any EM unique key constraints and reports errors.

 

Note:

Record "Copy" does NOT handle FILE type column data (For both dest=db/disk).

 

RecInfo

Link to access and change data record owner info. Allows to change / adjust App User and Data Group as per authorization in effect. Pre-requisites: Table properties Db Ops flags must be set to ‘O’ and conf param:  “em.param.data_owner_change” must be greater than zero.

 

Note: Disabled In App Run Mode.

 

 

 

 

Actual Data Record

Data record displayed as per layout.

FILE: If the field type is FILE, A link for file details, file download and file upload is displayed.

 

 

 

File Details

 

Use this screen to view file details for field types of FILE. There are options for Download, Upload or Content Link to Server File.

 

  • The options displayed can be different as per authorization level of user when running App.
  • To Content Link file on server, you need Content product license and when running app, Content Link File permission.

 

Screen Snapshot:

 

File Details screen has following information fields and options.

 

 

File Details

 

 

Name

File Name

 

Content Type

File Content Type

 

Size (Bytes)

File Size in bytes

 

Download

Link to Download the file.

 

Download Size (Bytes)

File Download Max size allowed.

 

Content

One Of: Yes or blank

Yes=File is a content source linked to a server file.

 

Path

File path.

 

 

 

 

File Upload/Overwrite

 

 

Upload

Button to Upload the file.

 

File Or Document

Client File name with path

 

Browse

Button to open File Chooser window.

 

 

 

 

Or, Content (link Server File)

 

 

Link

Button to link the file.

 

File Name with Path

Server File name with path to link

 

The links and options on this screen have following effect:

 

  • Download: Will download file to your browser. To Save the file right click link and select “Save Target As”.
  • Upload: Will upload the file from your machine to server and display status.
  • Link: Will verify existence, read ability of server file and then link to this record field.

 

 

Input/Edit Data (Form)

 

Use this screen to input or edit data in EM Table through a form.

 

  • EM Table properties, EM Keys are applied.
  • Uses form layout format and colors.
  • All form restrictions are applied, including Hide=Yes.
  • If any problems, debug via Input Data (No Form)

 

  • Transactions, Data Consistency Handling: Input/Edit Data Form comprise of a transaction which spans actions like data insert, Field level post process triggers, EM constraint verification (unique, foreign keys), Form level post process and any SQLException Errors from database.
  • If any custom SQL code in post processing issues an early commit, data consistency can hamper.

 

Screen Snapshot: Table - Input/Edit Data (Form)

 

Input/Edit Data screen has following information fields and options.

 

 

Actual Table field Prompts and Data input boxes

Input Form displayed as per layout, for Input Mode default values, if any, filled out. For Edit data record matching corresponding key is displayed.

 

If used Look-Up Table:

 

 

Look-Up

Link to Look-Table screen.

 

 

 

 

Submit

Submit this record for Input/Edit.

 

Reset

Reset values on form.

 

 

 

XML (Data) (Form)

 

Use this screen to view data in EM Table formatted as XML using only some of a form’s properties such as ‘Hide’. HTML properties of the form are ignored.

 

 

Screen Snapshot:

 

XML Data screen has following convention for formatting:

 

 

<?xml version='1.0' encoding='UTF-8'?>

 

<!--  EM Table Data  -->

<table_data>

      <user id="DEMO"></user>

      <!-- Table Info -->

      <table_info id="10003" name="Tbl1"></table_info>

<datarecord id="10002">

      <field

            id="10002"

            name="Fld 1"

            datatype="CHAR"

            sqlname=""

      >

            <value><![CDATA[abc]]></value>

      </field>

      ...

</datarecord>

...

</table_data>

<!--  End: EM Table Data  -->

 

 

 

Chapter 4: EM WebProjects

 

This chapter details how to create, manage and use WebProjects which are program modules to control application workflow and navigation.

 

 

Web Screens Workflow - WebProject Menu (EM Inbox)

 

When you click on WebProject Name link in EM Inbox, a screen is displayed to define workflow with options to add, del or change Web Screeens in the WebPorject module.

 

What is WebProject? :

 

  • WebProject is app workflow definition to handle 1 or more screens in designated Modes (Input/Query).
  • WebProjects help you build your application work flow into Menus and Screens.
  • WebProject with Screens accessible to Public are ways of publishing dynamic content on web sites. They also allow anonymous data capture for surveys, feedbacks, registrations.
  • Transactions, Data Consistency Handling: One Input/Edit Data Form means 1 transaction. Transactions spanning across multiple screens are not supported but can be programmatically implemented via post process SQL code extensions.

 

 

Screen Snapshot:

 

WebProject (EM Inbox) screen has following information fields and options.

 

 

Create New

Add new screen to WebProject.

 

Create - Copy From

Add new screen to WebProject via selecting an existing and copying it.

 

MarkSend

Mark WebProject object (All Screens) for EM Mail Compose.

 

 

 

 

WebScreen List:

 

 

Edit

Edit WebScreen definition

 

Del

Delete WebScreen

 

ChgTbl

Change the table associated with this Web Screen. Make sure the Form/Query Id is updated after table change.

 

Order

Screen Order No.

 

Proj #

WebProject ID number.

 

Scr #

WebScreen ID number.

 

Direct URL Access

Deny/Allow, Whether Direct URL Access Allowed.

 

Screen Mode

Mode of Screen: Input, Display.

 

Query Option

Query Option: InputQuery, SavedQuery, etc.

 

 

 

 

[Execute]

Link to Execute this WebScreen.

 

MarkSend

Mark a specific WebProject Screens for EM Mail Compose.

 

Table Name

Name of the base EM Table. A WebScreen can be based on only 1 table.

To display Master-Child data from 2 tables, use DisplayCombined options of those WebScreens.

 

(Select Table Link)

Link to go to Table Menu.

 

Table ID

EM Table Id No.

 

Screen Title

Title of Screen.

 

Sub-Title

Sub-Title of Screen.

 

Note: Public Access URL: To find the URL use, Portal Search screens.

 

 

Create New Web Screen

 

Select this option to add a new WebScreen to WebProject definition.

 

  • Displays list of EM Tables to select the base table for New WebScreen.

 

Screen Snapshot:

 

Select Table For WebScreen has following information fields and options.

 

 

Table List with:

 

 

Table Name

Name of the base EM Table.

 

Table Id #

EM Table ID number.

 

Date Created

Date the table was created.

 

 

 

 

Select

Link to Select the table for new WebScreen.

 

 

Create – Copy From (WebScreen)

 

Select this option to add a new WebScreen to WebProject definition via selecting an existing one and copying it.

 

Screen Snapshot:

 

Create – Copy From has following information fields and options.

 

  • Displays list of existing WebProjects with following information: WP Name, Screen Title, Sub-Title, Proj #, Scr#, Order, Table Name, Id, Mode, Prtl Acc., Created.
  • Select: Select this web screen to copy and add to current WebPorject as New one.

 

 

Edit WebScreen

 

Select this option to view or change a WebScreen definition in the WebProject.

 

Screen Snapshot:

 

Edit WebScreen has following information fields and options.

 

 

Properties:

 

 

Screen Order

Serial order of screen in WebProject.

Note: this is very important field. When you have deleted some screens, make sure rectify the serial increasing order (from 1,2,3,4, etc to max no. screens) for all the screens. Leaving gaps in screen order nos. can cause problems and is not supported.

 

Screen Title

Main Title.

 

Screen Sub-Title

Sub-title

 

Screen Title (Short)

Short Title used by menu style.

 

 

 

 

Security Options:

 

 

Password Protect?

No/Yes. If “Yes”, the user must enter the screen user id and password to access the form functionality.

 

Screen User ID

Screen User ID

 

Screen Password

Screen Password

 

 

 

 

Web Site Content Builder/Publisher Option:

 

 

Direct URL Access ?

Deny/Allow. If “Allow”, allows access to web screen and form functionality via direct URL link (Direct URL Access), without application sign-in.

 

Please refer to Using Direct Access URL section below.

 

 

 

 

Screen Mode

One of (Details in next section):

Display

Input

DisplayCombined

DisplayList

InputMulti

Edit

EditMulti

DisplayRecordNo

EditRecordNo

EditRecordNoDis

CopyAndEdit

TableCopyCheck

TableCopy

TableUpdCheck

TableUpd

CallBean

CallBeanStatus

 

Query Option

One Of:

DisplayAll = Display all data records.

InputQuery = Enter query form.

SavedQuery = Run previously saved qry.

JoinQuery = Run table-join query (for DisplayCombined screens.

ListQuery = Display saved query list.

 

 

Notes on usage:

In Modes: Edit & EditMulti:

  • Using InputQuery will display Query Form to select data. The List Saved Query Link will not work in this case.
  • Using any other mode is equivalent to DisplayAll i.e. select all records for editing. Links and actual 1 or more records displayed for edit as per Edit, EditMulti settings.

 

 

 

 

Form Parameters?

One of:

No = No parameters

Send = Send parameters to next screen

Get = Receive parameters

Both = Both send and receive parameter.

 

 

 

 

Send Param

Send Parameters details. See below.

 

Get Param

Receive Parameters details. See below.

 

 

 

 

 

 

 

Table Id:

Table ID number.

 

Form Id

Form ID number for this table.

 

Query Id

Query ID number for this table, if any.

 

Edit Form Id

Alternative Form ID number, if any, for this table to be used for Edit link selected via DisplayMode.

 

 

 

 

Screen Menu Style

One Of:

Blank = PrevNext

PrevNext = Use labels: PREVIOUS NEXT

Display 2 links only

PrevNextLong = Use Title links

PrevNextShort = Use Short Title links

ListLong = List all web screens, use Title

ListShort = List all web screens, use short title

 

 

Screen Menu Position

Positioning of Screen Menu, one of:

‘ ’ (Blank) = Both.

Both = At top and end.

Top = Only at top.

End = Only at end.

None = Hide Menu

 

Script /C. Menu Position

Positioning of Custom Menu, one of:

‘ ’ (Blank) = Do not process.

Both = At top and end.

Top = Only at top.

End = Only at end.

None = Do not process

Please refer to “EM Script Code Processing” for more details.

 

Scirpt or Custom Menu HTML (Upto 2000 char)

Script Code and/or HTML text for Custom Menu.

 

 

FreeStyle HTML?

Display FreeStyle HTML flag, one of:

No = Do not display

Before = Only display Before HTML text

After = Only display After HTML text

Both = Display both Before/After HTML text

Please refer to “EM Script Code Processing” for more details.

 

Before HTML text (Upto 2000 char):

Free Style HTML text for displaying at the top.

 

After HTML text (Upto 2000 char):

Free Style HTML text for displaying at the end.

 

 

Using different Screen Modes:

  • Display: Display data records.
  • Input: Input single data record.
  • DisplayCombined: Useful for Display data records from multiple (2 or more) tables/forms. The screen marked as DisplayCombined looks for subsequent screens marked as DisplayCombined (IGNORES or filters all other subsequent screens if not marked DisplayCombined) and treats them as combined and attached with the previous screen. So that both the data records from previous and this screen are displayed. Use Query Mode JoinQuery (in second or later screen) to display Mater-Detail or Master-Mater table data records with this mode. First screen should be InputQuery.
  • DisplayList: Display only list (links) of matching data records but not actual data.
  • InputMulti: Input multiple data records on same form. Specify the number of records to input in field “Edit Form Id”.
  • Edit: Query and Edit single data record. If query fetches more than one records, edit record no links are displayed to get to other data records.
  • EditMulti: Query and Edit multiple data records on same form. Specify the number of records to edit in field “Edit Form Id”. If query fetches more than the number of records to edit, edit record no links are displayed to get to other data records.
  • DisplayRecordNo: Display one data record matching the record number specified. Specify the record No in “Query Id”.
  • EditRecordNo: Edit one data record matching the record number specified. Specify the record No in “Query Id”.
  • EditRecordNoDis: Edit one data record matching the record number specified. Specify the record No in “Query Id”. This means the form is input/edit form but without Submit button. Use this option to display record but use input/edit form.
  • CopyAndEdit: Copy data record matching the record number specified and Edit it. Specify the record No in “Query Id”.
  • Table Copy And Update Modes (with Check): These modes allow to execute a table-to-table data copy or data update transaction. Some of the general considerations are: 1) Suffix Check means only check no of rows affected. No actual data copy or update is done. 2) Specify table join id in “Query Id” field. 3) Which table is queried? : For table copy the Source table is queried for data rows. For table update (the source table & target table should be same), target table is queried for matching data records to update. 4) Query Option: A] If InputQuery is specified then a Query Form is displayed and matching rows are used upon submitting query. B] If any other option is specified, then the number of rows selected depends upon the Query Id specified on Table Join definition. If non-zero then use that as saved query id number, if zero then perform a “Select All Rows”.
    • TableCopyCheck: Execute Table Copy Data option, but only check no of rows affected. No actual data copy.
    • TableCopy: Execute Table Copy Data option.
    • TableUpdCheck: Execute Table Update Data option, but only check no of rows affected. No actual data update.
    • TableUpd: Execute Table Update Data option.
  • CallBean: Execute Call Bean option. A custom bean must exist with it’s jsp file as: /em/custom/jsp/CB_<User Id>_<WP Id>_<Scr Id>.jsp. e.g. CB_DEMO_10004_10018.jsp
  • CallBeanStatus: Execute Call Bean option. And check status of bean via call to bean.getStatus() method. Return value 1=Pass, 0-Fail.

 

 

Using Direct Access URL :

 

While using this mode following should be considered:

 

  • Following Screen Modes are supported for Direct URL Access:

Display, DisplayCombined

Input, InputMulti, Edit, EditMulti,

DisplayRecordNo, EditRecordNo,

EditRecordNoDis, CopyAndEdit,

CallBean, CallBeanStatus

  • Following Screen Modes are not supported for Direct URL Access:

DisplayList,

TableCopy, TableCopyCheck

TableUpdCheck, TableUpd

  • The Data Grp and App User are set as Inbox/App Owner. E.g. For Inbox User Id UnivAdmission, the Data Grp and App User will be set to: UnivAdmission.
  • Multiple Data Grps are not supported.
  • For enhanced security and protection of Direct Access allowing addition of or change of data, you can set and use screen userid/password locking.
  • When using some screen modes, some of the links will not work. E.g. record Edit, Del, Copy, etc links on display or additional record links displayed in Edit modes.

 

NOTE: If you have set “Direct Access URL” Allow to Screen then, it is also available with data display or input permissions from Application access which has not otherwise granted e.g. Read or Add data permissions.

 

 

Using Send/Receive Parameters:

 

The receiving screen can utilize the parameter values in following situations:

  • Input Mode: The field value will be populated with received value.
  • Query Mode: The field value of a query field in: a) SavedQuery will use the dynamic received value instead of stored value.

 

Specifying Send/Receive Parameter details:

  • Use following format.
  • [Format: <Identifier:Field Id:Field Name:...>]
  • e.g. Fld1_2_3:11081:Fld_1:11082:Fld_2:11083:Fld_3:
  • Where: Field Id is sender or receiver screen’s table field id.
  • Field Name is used for exchanging of data to respective fields. No blanks allowed.
  • Only one set of Send and one set of Receive Parameter details processed per web screen as identified by ‘Identifier’.

 

Note: Data Value Restriction: The data value of parameter sent should not contain “:” as it is not supported.

 

 

For example:

 

Screen 1 has following fields (Field Name, Field Id):

Emp no, 10128

Dept Id, 10130

 

Screen 2 has following fields (Field Name, Field Id):

Emp no, 10341

Dept Code, 10345

 

To send the parameters from Screen 1 to Screen 2,

 

On Screen 1, Send Param will have following:

EMP_DEPT:emp_no:10128:dept_data:10130:

 

On Screen 2, Get Param will have following:

EMP_DEPT:emp_no:10341:dept_data:10345:

 

 

Delete WebScreen

 

Select this option to delete a WebScreen from the WebProject.

 

Screen Snapshot:

 

Del WebScreen:

 

  • This option allows to delete a WebScreen.
  • Confirmation Screen Displayed with information given below:
  • Screen Id, Screen Order , Screen Title , Screen Sub-Title , Table Id , Form Id , Query Id
  • Clicking Delete button will Delete this screen.
  • Verify and correct any Screen Order gaps caused by the delete.

 

 

WebScreen: Execute in EM Inbox or Direct access via URL

 

Select this option to run a WebScreen in the WebProject. Similar screen is displayed after accessing the web screen directly via URL, when public access is allowed.

 

Screen Snapshot:

 

Execute WebScreen has following information fields and options apart from the actual form details:

 

Note: EM Menu options for Inbox or Application are not displayed.

 

[W] MENU: Link to Select WebProject Root

Menu Items: As defined in WebProject

String displayed: Powered By EasyManage

 

 

Web Screen Workflow : Execute in Application

 

Execution of Web Screens in Application Workflow is selected thru WebProject Menu List.

 

Screen Snapshot:

 

EM Menu options for Application are displayed.

 

[W] MENU: Link to Select WebProject Root

Menu Items: As defined in WebProject

String displayed: Powered By EasyManage

 

 

Chapter 5: POWER Search (Explorer_PLUS)

 

This chapter details on how to use POWER Search queries features which provide EM application definition and data records retrieval capability at your fingertips.

 

POWER Search/ Explorer_PLUS

 

Select this option to run one of the power search queries.

 

Screen Snapshot: POWER Search (Explorer_PLUS)

 

POWER Search/Explorer_PLUS has different forms in separate sections to search folders, fields, data records, WebProjects, etc. At the beginning are links to list categories of a type. The sections are described below in separate sub-headings.

 

General considerations for using POWER search are as below.

 

  • Search is case sensitive.
  • For wild card search add percent character (%) where required, e.g. To search all field names having 'Id' in them, Search For %Id%
  • In Search Table Data: Query values for DATE/DATETIME/TIME should be entered in respective full input format as you would on input form. Wild card(%) not allowed for DATE/DATETIME/TIME.
  • Data record searches are applicable to EM Tables [DEF] (not linked to database) data records.

 

 

List (500) EM Objects Menu

 

Select this option to run one of the power search queries.

 

Links to list upto 500 EM Objects of a type, are as below:

  • Text or Folders
  • Tables
  • WebProjects
  • All Of These

 

  • Table Fields
  • WebProject Screens

 

For Search Result Screens, please refer to respective sections below.

 

Common Parameters - Check Dates/Sorting

 

Following search parameters are applicable to all the search forms. Their respective implications, if specific, are detailed in individual sections.

 

Search Form “Common Search Parameters” section has following information fields and options:

 

·        Check Dates: Drop-down One of: “--Do Not Check--”, Created Or Updated, Created, Updated. Searches for EM Object created or updated dates.

·        Between Date 1: Begin date for check dates. Blank Defaults to Now.

·        Between Date 2: End date for check dates. Should be greater than or equal to begin date to yield results. Blank Defaults to Now.

·        OR, : Click this box to ignore between dates but use “within last days” parameter.

·        Within Last nn Days: Number of days before today to search from.

 

·        Sort By: One of: (Blank), Id, Name, Created, Updated. Where: Id = EM Object Id, Name = EM Object Name, Created = EM Object Created date, Updated = EM Object updated date. If Sort By is specified, Results will be sorted on that particular field. For table data, Name = The field value.

·        Sort Order: One of: (Blank), Ascending, Descending

 

·        *Date Input Format: [applicable date input format e.g. mm/dd/yyyy hh:nn AM/PM], Blank = Now 

 

 

Search Folders/Categories/Tables

 

Use this form to search for different categories (EM Explorer Objects) i.e.  folders/ categories/ tables.

 

Search Form section has following information fields and options:

 

·        Search For: The search parameter value.

·        OR, Display All: Click this box to ignore parameter value but display all matching records.

·        In: One of: Text or Folder, Table, WebProject, All Of Above

·        Limit Rows: One of: 20, 50, 100, 300, 500, 1000, 1500, 2000, 100000

·        Submit: Form Submit button.

·        Common Parameters: Refer to section before.

 

Search Result Screen will display following information:

 

Screen Snapshot: Search Results Categories

 

  • Id: Category ID number.
  • [Folder Type] Name: Type of folder: [E] = Text of Folder, [T] = Table, [W] = WebProject, and name of object.
  • Created/Updated: Date when created/updated.
  • Edit/Del/Archive/Copy/Cut/Paste/MarkSend: EM Object Links as applicable.

 

 

Search Table Fields

 

Use this form to search for matching table fields in any EM tables.

 

Search Form section has following information fields and options:

 

·        Search For: The search parameter value.

·        OR, Display All: Click this box to ignore parameter value but display all matching records.

·        In: Table Fields

·        Limit Rows: One of: 20, 50, 100, 300, 500, 1000, 1500, 2000, 100000

·        Submit: Form Submit button.

·        Common Parameters: Refer to section before.

 

Search Result Screen will display following information:

 

Screen Snapshot: Search Results Table Fields

 

  • Table Id#: Table ID number.
  • Table: Table name.
  • Field Name: Name of field.
  • SQL ID: Field’s SQL ID identifier.
  • Data Type: Field’s data type.
  • Length: Length
  • Display Len: Display Length
  • Table: Link to select the table.
  • List WebProjects: Link to list WebProjects using this table.
  • Created: Date when created.

 

 

Search Table Data

 

Use this form to search for matching table data records in any EM Tables [DEF] (not linked to database).

 

Search Form section has following information fields and options:

 

  • Datatype: Select a data type from dropdown list. One of: CHAR, NUMBER, MONEY, DATE, DATETIME, TIME, FLOAT, BOOLEAN, TEXTS, HYPERLINK, FILE_INFO.
  • Label Data: Indicates look for data of the above data type.
  • Operator: The search operator. One of: =, Like, <, >, <=, >=.

·        Ignore Case: No/Yes.

·        Search For: The search parameter value.

·        Submit: Form Submit button.

·        Sort Order: One of: ‘ ’ (Blank) = Database default, Ascending, Descending

·        Limit Rows: One of: 20, 50, 100, 300, 500, 1000, 1500, 2000, 100000

·        Common Parameters: Refer to section before.

 

Search Result Screen will display following information:

 

Screen Snapshot: Search Results Table Data

 

  • Field Name: Name of field.
  • Value: Data value of field.
  • Table: Table name.
  • Record #: Data record ID number.
  • Tbl Data Record: Link to go to table data record.
  • List WebProjects: Link to list WebProjects using this table.
  • Updated: Date when data record last updated.

 

 

Search WebProject Screens

 

Use this form to search for WebProject: WebScreens matching given Title or Sub-title.

 

Search Form section has following information fields and options:

 

·        Search For: The search parameter value.

·        OR, Display All: Click this box to ignore parameter value but display all matching records.

·        In: Screen Title or Sub-Title.

·        Limit Rows: One of: 20, 50, 100, 300, 500, 1000, 1500, 2000, 100000

·        Submit: Form Submit button.

·        Common Parameters: Refer to section before.

 

Note: In Run Application Mode, and when Data Tagging is enabled following additional search criteria is available.

·        Check For Tagged Records by ANYONE:

o       Drop-down One of: “--Do Not Check--”, Has Tagged Data Recs.

·        Check For YOUR Tagging:

o       Drop-down One of: “--Do Not Check--”, Tagging Base Created, Tagging Configuration (defined), Tagged Data Recs.

 

Search Result Screen will display following information:

 

Screen Snapshot: Search Results WebProject Screens

 

  • Id#: WebProject ID number.
  • WebProject: WebProject name.
  • Screen Title: Title of WebScreen.
  • Screen Sub-Title: Sub-Title of WebScreen.
  • Created: Date when created.
  • Details: WebProject Link to select the WebProject.

 

 

Chapter 6: Applications

 

This chapter details on how to define application access authorization i.e. register apps, subscribe to them, define applications, branches, profiles, etc.

 

 

Applications Menu

 

Applications Menu is displayed when “Application” link is selected in EM Inbox. 

 

Screen Snapshot:

 

Applications Menu screen has following information fields and options:

 

  • AppHome: Display the Application Menu.
  • Register: Register a new application.
  • Subscribe: Subscribe to an application.
  • List Applications: List subscribed applications available to run.

·        The Multi-App Search: Search for application User Names, Ids, Keywords.

·        Auth Define/Grant: To define granular individual screen level application authorizations.

o       Auth Options: Sub-Menu.

o       Data Groups: Define Multiple data groups for Subscribed Apps and Granular Apps.

o       Auth Roles/Grants:

§        Auth Role Details

§        Data Groups

§        Grants

o       User Grants:

§        Grant Data Groups

 

 

Application Register

 

Application Register Menu displays the list of applications registrations and provides option to create a new, edit or delete application registration.

 

Screen Snapshot:

 

Application Register screen has following information fields and options:

 

·        Create New Record: Link to register a new application definition. See below.

·        Edit: Edit the application registration entry. See below.

·        Del: Delete the application registration entry. A confirmation screen is displayed before deletion. See below.

·        Profile: Edit the profile for this application registration entry. The screen is similar to “User Profile” screen under “Options” menu. The User Id displayed is Application Registration Id.

·        MarkSend: Marks the application registration entry for EM Mail Compose.

·        DataGrps: Define the Data Groups available to this app entry.

·        Record Id: The application registration record id number.

·        Register User Id: The application owner User Id.

·        Register Data Group: The application data group registered.

·        Level: The application registration level.

·        Register Category Id: The application branch category id or zero (0) if none.

·        Access String: The application registration access granted string.

·        Updated By – Date: The User Id updating this record, updated date.

·        App Brach/Role: The information on app branch or authorization role.

 

 

Application Register: Create New, Edit, Delete Screen

 

Application Register: Create New/Edit/Delete screen is as below. This screen displays fields and information to be entered to create a new or edit application registration. On Delete screen the information is only displayed for confirmation.

 

Screen Snapshot:

 

Application Register: Create New/Edit/Del screen has following information fields and options:

 

·        User Id: The application owner User Id.

·        Record Type: Register

·        Level *: The application registration level. There are logical groups to specify the level. Those logical groups and the actual level values are as below:

o       Application Group: Defines application access registration where the users get access to objects as application users and can perform data tasks (add/change/etc) as allowed. This group has different values, which allow for different classification, otherwise there is no difference from system point of view. Only registered users can be this group’s subscribers.

§        Application: Used to specify application registration

·        “Application” can Also can be used for various following types of definitions:

·        Portlet: portlet (small app) registration

·        AppBranch: app branch registration.

·        AppModule: app module registration.

·        AppContent: app content registration.

o       Special Values Group: Each value has special significance as indicated. Only registered users can be this group’s subscribers.

§        InboxApp : Allows the subscribers to copy/ refresh application object and data tree of the owner into their EM Inbox. Used for User registration where an application template is required after sign-up.

§        Superuser : Allows another User ID to be superuser to your EM Inbox. Used for assuming identity of other users.

o       Content Group: Defines content services access registration where the users get access to objects as application users and can perform search and data tasks (add/change/etc) as allowed. Registered or public users can be this group’s subscribers. These are PUSH type of apps where The access is available without the need for creating subscription record on app users’s end.

§        ContentSpecUser: Used for access by specific registered users only. Please see “How does Specific Users Authorization Work” below.

§        ContentAuthUser: Used for access by registered users only (all users having Inbox).

§        ContentAnyUser: Used for access by non-registered users, requests user’s e-mail or name as user id for sign-in.

§        ContentPublic: Used for access by non-registered users, captures session id as user’s id for sign-in.

o       Collaboration Group: Defines collaboration access registration where the users (subscribers) either get full access to Owner’s EM Inbox objects and they also can perform search and data tasks, or they can perform Inbox-to-Inbox level object transfer functions. Please note that Read/Add/Change/Delete/Archive Security Permissions have special meaning for collaboration, they indicate Inbox-to-Inbox level object transfer capabilities. Please refer to Collaboration chapter for details. Registered or public users can be this group’s subscribers.

§        For Inbox-to-Inbox level object transfers:

·        Collaboration: Used for defining collaboration access registration of type Inbox-to-Inbox object-data transfer, for use by a group of registered users only after creating subscription record.

·        CollabAppAuthUsr: Used for defining collaboration access registration of type Inbox-to-Inbox object-data transfer, for use by any registered users, without need for creating any subscription record.

·        CollabAppSpecUsr: Used for defining collaboration access registration of type Inbox-to-Inbox object-data transfer, for use by specific users only, without need for creating any subscription record. Please see “How does Specific Users Authorization Work” below.

§        For Full access to Owner’s EM Inbox

·        NOTE: PLEASE USE FOLLOWING WITH CAUTION AS YOU ARE GRANTING FULL ACCESS TO YOUR INBOX TO OTHERS

·        CollabSharedAuthUsr: Used for defining collaboration access registration of type access to Owner’s EM Inbox, for use by registered users only but without the need for creating subscription record.

·        CollabSharedSpecUsr: Used for defining collaboration access registration of type access to Owner’s EM Inbox, for use by specific users only but without the need for creating subscription record. Please see “How does Specific Users Authorization Work” below.

·        CollabSharedPublic: Defines collaboration access registration of type access to Owner’s EM Inbox, where non-registered users get full access to Owner’s EM Inbox objects and data. This is way of defining Superuser or Assume Identity type of access for public.

·        Register User Id *: The application owner User Id.

·        Register Category Id: The application branch category id or zero (0) if none.

o       Note: For Content and Collaboration levels, do not leave the value to zero (0). As this will disable the search. Instead use a valid category id branch e.g. 200 for Inbox, 300 for Application, etc.

·        Register Data Group *: The application data group to be registered, either new or existing one.

·        Authorization *: The authorization token (password) for this application registration.

·        Auth. Thru Date *: The authorization valid till date for this application registration.

·        App Brach/Role: The information on app branch or authorization role.

·        Security Permissions: The application registration access granted information. Has checkboxes for: Read Data, Add Data, Change Data, Delete Data, Access Group Data, Multi Record Changes, Archive Data, Table Access, File Download, File Upload, Content File Link.

·        Submit: Form submit button.

·        CANCEL: Form cancel button.

 

 

 

How does Specific Users Authorization Work

 

·        Applicable For ContentSpecUser,  CollabAppSpecUsr, CollabSharedSpecUsr

·        Used for access by specific registered users only.

·        The users are specifically defined in Granted Users section with “Grants” link.

·        The access can be availed directly or via Auth Role defined or via a group (Network, Groups, etc.) user belongs to.

·        The Authorization Role Type must be “SPECUSER”. Please see details below.

 

Defining Auth Roles For “Specific Users Authorization” Grants:

Please use Inbox Menu : Applications : Auth Roles/Grants.

 

OR “Grant” Link available from Application Register screen.

  • Please create Auth Roles with Auth Type: “SPECUSER”.
  • You can define list nested up to 2 levels.

 

For Example:

  • Create Auth Type: SPECUSER,  Auth Name: SpecUserList1
    • Grant : Create Grant To User Id: SpecUserListDet1
  • Create Auth Type: SPECUSER,  Auth Name: SpecUserListDet1
    • Grant : Create Grant To User Id: Consumer1
    • Grant : Create Grant To User Id: Consumer2
  • Now you can Grant to Role “SpecUserList1” and this provides Specific User access to Consumer1 & Consumer2

 

 

Using Security Permissions:

Most are self evident, some of the permissions are detailed below:

  • Access Group Data: Allows for access to data records of other users with Data Grp same to current.
  • Multi-Record Changes: Enables execution of multi-record transactions such as “Query & Delete/Archive”, Table-to-Table data copy, etc.
  • Table Access: Enables to applications users, table data UnDelete and Archive-Restore functions.
  • Content File link: Enables linking the FILE datatype record field to a system file on server.

 

Security Permission Considerations for “Collaboration”, “CollabAppAuthUsr”:

When registering a “Collaboration”, “CollabAppAuthUsr” type, permissions have following meaning. Only Read/Add/Change/Delete Data are used in such case. Link-To-MyCopy is allowed in all cases.

 

Read Data:

Allows for Create-New-MyCopy and

From Collaboration ====> To MyCopy

Refresh

RefreshUpdate

Copy

 

Add Data:

Allows for

To Collaboration <==== From MyCopy

Copy

 

Change Data:

Allows for

To Collaboration <==== From MyCopy

Refresh

RefreshUpdate

 

 

Delete Data:

Allows for

To Collaboration <==== From MyCopy

CleanUpMaster-Refresh : This action DELETES the Collaboration EM Inbox (i.e. completely remove all objects-data excluding user info, app reg/sub info), and refreshes from MyCopy EM Inbox.

 

 

 

Application Subscribe

 

Application Subscribe Menu displays the list of applications subscriptions and provides option to create a new, edit or delete application subscription.

 

Screen Snapshot:

 

Application Subscribe screen has following information fields and options:

 

·        Create New Record: Link to subscribe to a new application. See below.

·        Edit: Edit the application subscriptions entry. See below.

·        Del: Delete the application subscriptions entry. A confirmation screen is displayed before deletion. See below.

·        Profile: Edit the profile for this application subscriptions entry. The screen is similar to “User Profile” screen under “Options” menu. The User Id displayed is Application Subscription Id.

·        Record Id: The application subscriptions record id number.

·        Subscribe User Id: The application owner’s User Id.

·        Subscribe Data Group: The application data group.

·        Level: The application level.

·        Subscribe Category Id: The application branch category id or zero (0) if none.

·        Access String: The application access permitted string.

·        Updated By – Date: The User Id updating this record, updated date.

·        App Brach/Role: The information on app branch or authorization role.

 

 

Application Subscribe: Create New, Edit, Delete Screen

 

Application Subscribe: Create New/Edit/Delete screen is as below. This screen displays fields and information to be entered to create a new or edit application subscription. On Delete screen the information is only displayed for confirmation.

 

Screen Snapshot:

 

Application Subscribe: Create New/Edit/Del screen has following information fields and options:

 

In order to subscribe to an application, following information must be sought from the owner: Owner Id, Level, Category Id (if any), Data group, Authorization token (password).

 

·        User Id: The application subscriber’s User Id.

·        Record Type: Subscribe

·        Level *: The application level.

·        Subscribe User Id *: The application owner User Id.

·        Subscribe Category Id: The application branch category id or zero (0) if none.

·        Subscribe Data Group *: The application data group.

·        Authorization *: The authorization token (password).

·        Auth. Thru Date: The authorization valid till date. Only displayed.

·        App Brach/Role: The information on app branch or authorization role.

·        Security Permissions: The application subscription access permitted information. Information displayed on Edit/Del screen only.

·        Submit: Form submit button.

·        CANCEL: Form cancel button.

 

 

List Apps

 

This screen lists applications subscribed to and available to run, and allows to “Run” an application.

 

Please refer to “Server: Using Applications” chapter for details.

 

 

Multi-App Srh

 

Please refer to “Search Server: Search Options” chapter for details.

 

 

 

Auth Define/Grant

 

This Menu displays the list of applications authorization – Options such as: Data Groups, Auth Roles/Grants, User Grants.

 

 

 

Run Application

 

Please refer to “Server: Using Applications” chapter for details.

 

 

Chapter 7: Options & Settings

 

This chapter details on how to set Options, Settings & use Tools. The areas covered are User Options, Profiles, International Settings (date formats, currency, language settings, etc. and use reports.

 

 

Options Menu (In Inbox)

 

Options menu has sections and links to select different option screens as below.

 

Screen Snapshot:

 

Member Account

  • Update Registration Data
  • Update User Profile (International/GUI Preferences)
  • Change Password

 

Add Third Party Account to SignIn With*

  • Add Facebook Account

 

Table and Forms

  • Default Form Properties,  [Paste,  Copy]
  • Default Field Properties,  [Paste,  Copy]
  • GLOBAL Form Properties Update (Cosmetic)
  • GLOBAL Field Properties Update (Cosmetic)

 

Utilities        

  • Refresh Category Tree [For Non-Oracle Databases only].
  • Upload Menu & Images : My Menu, Menu Image Icons, Help Files, Public Profile

 

 

Settings Menu (In Inbox)

 

Options menu has sections and links to select different option screens as below.

 

Screen Snapshot:

 

Session Settings

  • Data Groups : Set Data Group preferences for session.
  • Update User Settings Profile (Session) : Use "Set For Session" Button

 

 

 

Member Account: Update Registration Data

 

Use this screen to view or change sign-up data i.e. User Registration Data.

 

Screen Snapshot:

 

Signup data Update Screen has following information fields and menu options.

 

 

 

 

 

* indicates field must be entered

 

 

Last Name

Last Name

 

First / Given Names

First/Given Names

 

E-mail *

E-mail

 

 

 

 

Display Name *

To be displayed As Name Of User / Network / Group / Application

 

Description

Description of User / Network / Group / Application

 

Search Key Words

Keywords for search on User.

 

 

 

 

Privacy Settings

Display Of Information in Searches as per checked.

 

Portal Access? 

Enables public search on WP with Direct URL Access links

 

No/Yes, Yes: Allows search on keywords and WebProject screens with Direct URL Access=Allow (Yes).

 

NOTE: Direct Access URL links are available if known, even when Portal Access is set to No. This setting only controls searches on those links.

 

Content Access ?

Enable Content[Type] App Access.

 

No/Yes. Is Master Level Switch. If

Yes: Allows search on Content[Type] type of Application Registrations, and enables app logins to them.

 

 

 

 

Gender

Gender: Male,Female,” “ (Blank)

 

Date Of Birth /Establishment 

 

 

Year

Date Part: Year, nnnn

 

Month

Date Part: Month

 

Day

Date Part: Day

 

 

 

 

 

 

 

Inbox type

Inbox type

 

Sub-Type   

Inbox Sub-Type

 

 

 

 

Contact Address

 

 

Line 1

 

 

Line 2

 

 

Phone – Home

 

 

Phone – Work

 

 

Mobile / Cell

 

 

IM / Pager

 

 

Fax

 

 

 

 

 

City

City

 

State   

State   

 

Zip

Zip code

 

Country

Country

 

Web Site

 

 

Web Site 2

 

 

 

 

 

Company Name

 

 

Branch Location

 

 

 

 

 

Email Account Details

Available from Options : Update Registration Data Menu.

 

Email Account From Service

 

 

Mail User ID

Mail Server User ID. E.g. “User1

 

Password  

Mail Server User Password.

 

 

Note: Mail Folder defaults to “INBOX”.

 

Mail ReplyTo

Specify a different Mail ReplyTo Address than the From Address. Useful when Inbox is not for a person but for a dept or nework entity. Then ReplyTo can specify email of the owner person.

 

Mail Auto BCC To

Specify a Mail Address to which All Sent mails are forwarded as BCC.

 

 

 

 

Additional POP Email Accounts (Store Max: 10, Can Use/Mark Active: First nn):

Details of additional POP email accounts from Srl #1 to #10.

 

Account Srl # nn

 

 

Keep / Add ?

Checked=Yes

 

Active ?

Checked=Yes

 

Check Mail Default

Checked=Yes

 

Send Mail Default

Checked=Yes

 

Email Account Name:

 

 

Your Name : 

 

 

Mail User Id :

 

 

Mail User Password: 

 

 

ReplyTo : 

 

 

Auto BCC To : 

 

 

Incoming Server :

 

 

Protocol :  

(Default: pop3)

 

Server :   

 

 

Port : 

(Default: 110)

 

Outgoing Server :

 

 

Protocol :  

(Default: smtp)

 

Server :   

 

 

Port : 

(Default: 25)

 

Requires Authentication :

Checked=Yes

 

 

 

 

 

 

 

 

 

 

User Information:

 

 

 

 

 

User ID

User ID displayed.

 

User ID No

User ID number displayed.

 

Info

 

 

Tp Si

 

 

Parent User [No]

 

 

Tbl Pref

 

 

User Param Prop

 

 

Created

Date of Sign-Up.

 

Updated

Date last updated.

 

 

 

 

 

Member Account: Change Password

 

Use this screen to change user password. You must know your existing password to select a new password. If you forget your existing password, contact your EM System Administrator.

 

Screen Snapshot:

 

Signup Data - Change Password screen has following information fields and menu options. To Change Password, Please enter your old password and then select a new one.

 

 

* indicates mandatory field.

 

 

Old Password *

Current Password for this User ID.

 

New Password *

New Password for this User ID. Must be 6 chars long.

 

Re-enter New Password *

Re-enter the new password for verification.

 

 

Member Account: Update User Profile

 

Use this screen to view or change user profile including (International/GUI Preferences). Depending upon the database used, different options are displayed as applicable.

 

Screen Snapshot:

 

User Profile screen has following information fields and menu options.

 

 

 

User Id

User ID.

 

Impose this profile?

No/Yes.

Used by Application Run:

If Yes, attempt will be made to prefer this profile over the application owner’s (if owner’s app profile field set to No).

 

 

International settings (Date/Time Formats,…):

 

This section lists the international settings options like Date/time formats, currency, float/money formats, language settings, etc. These options are database specific and are listed under the database headings.

 

For Oracle:

 

Screen Snapshot:

 

 

 

Note: Format elements allowed are listed below this table.

 

Date format - Display:

Date format to be used for displaying dates.

 

Date format - Input:

Date format to be used for inputting dates. This will be the input mask against which date string will be validated.

 

Time format - Display:

Time format to be used for displaying time.

 

Time format - Input:

Time format to be used for inputting time. This will be the input mask against which time string will be validated.

 

 

 

 

Datetime Formats (Not captured on screen.)

DATETIME uses: DATE format + “ ”(blank) + TIME format.

 

 

 

 

Date/Time Display Preview:

Current date/time displayed using the formats stored before.

 

 

 

 

Currency Symbol:

Currency Symbol

 

Money format - Display:

Money data type format for Display

 

Float format - Display:

Float data type format for Display

 

Language/Territory:

Oracle only.

International Settings: Language/Territory information.

 

 

****** Date Formats ******:

DD - Day of month (1-31)

MM - Two-digit month (01-12; JAN = 01)

YYYY - 4-Digit of Year

Dy - Abbreviated name of day

Day - Name of day

d - Day of week (1-7)

dDd - Day of year (1-366)

Month - Name of month

Mon - Abbreviated name of month

yy - Last 2 Digits of Year

Year - Year, spelled out

IW - Week of year (1-52 or 1-53)

ww - Week of year (1-53) where week 1 starts on the first day of year

W - Week of month (1-5) where week 1 starts on the first day of the month

J - Julian day; the number of days since January 1, 4712 BC

Q - Quarter of year (1, 2, 3, 4; JAN-MAR = 1)

AD - AD indicator

BC - BC indicator

 

****** Time Formats ******:

HH - Hour of day (1-12)

hh12 - Hour of day (1-12)

hh24 - Hour of day (0-23)

MI - Minute (0-59)

SS - Second (0-59)

AM - Meridian indicator (AM/PM)

 

****** Float/Money Format ******:

Allowed elements are: , . 9 0 S $ B C G FM L

 

 

For MS SQL Server:

 

Screen Snapshot:

 

 

 

Note: Format elements allowed are listed below this table.

 

Date format - Display:

Date format to be used for displaying dates.

 

Date format - Input:

Date format to be used for inputting dates. This will be the input mask against which date string will be validated.

 

DateTime format - Display:

DateTime format to be used for displaying datetime.

 

Time format - Display:

Time format to be used for displaying time.

 

Time format - Input:

Field Not captured. Allowed formats as allowed by database, given below.

 

 

 

 

Datetime Formats (Not captured on screen.)

DATETIME uses: DATE format + “ ”(blank) + TIME format.

 

 

 

 

Date/Time Display Preview:

Current date/time displayed using the formats stored before.

 

 

 

 

Currency Symbol:

Currency Symbol

 

Money format - Display:

Money data type format for Display

 

Float format - Display:

Float data type format for Display

 

Language/Territory:

Oracle only.

International Settings: Language/Territory information.

 

 

Date format - Display: Select from dropdown, one of:

"101 = mm/dd/yyyy",

                    "102 = yyyy.mm.dd",

                    "103 = dd/mm/yyyy",

                    "104 = dd.mm.yyyy",

                    "105 = dd-mm-yyyy",

                    "106 = dd mon yyyy",

                    "107 = mon dd, yyyy",

                    "110 = mm-dd-yyyy",

                    "111 = yyyy/mm/dd",

                    "112 = yyyymmdd"

 

Date format - Input: Select from dropdown, one of:

                    "mdy = Month Day Year",

                    "myd = Month Year Day",

                    "dmy = Day Month Year",

                    "dym = Day Year Month",

                    "ydm = Year Day Month",

                    "ymd = Year Month Day"

 

DateTime format - Display: Select from dropdown, one of:

                    "100 = mon dd yyyy hh:miAM (or PM)",

                    "109 = mon dd yyyy hh:mi:ss:mmmAM (or PM)",

                    "113 = dd mon yyyy hh:mm:ss:mmm(24h)"

 

 

NOTE:

Date Formats Consistency: Keep all date formats mentioned above to maintain consistency as to mdy or dmy or ymd.

 

 

Time format - Display: Select from dropdown, one of:

                    "108 = hh:mm:ss",

                    "114 = hh:mi:ss:mmm(24h)"

 

****** Date/Time Formats Masks: Input ******:

Input:

These alphabetic date formats are acceptable for any input setting:

Apr[il] [15][,] 1996

Apr[il] 15[,] [19]96

Apr[il] 1996 [15]

Apr[il] [19]96 15

[15] Apr[il][,] 1996

15 Apr[il][,][19]96

15 [19]96 apr[il]

[15] 1996 apr[il]

1996 APR[IL] [15]

[19]96 APR[IL] 15

1996 [15] APR[IL]

These Numeric date formats are acceptable:

You must specify the month, day, and year in a string with

slashes (/), hyphens (-), or periods (.) as separators.

This string must appear in the following form:

num sep num sep num [time_spec] [time_spec]

These numeric formats are acceptable:

[0]4/15/[19]96 (mdy)

[0]4-15-[19]96 (mdy)

[0]4.15.[19]96 (mdy)

[04]/[19]96/15 (myd)

15/[0]4/[19]96 (dmy)

15/[19]96/[0]4 (dym)

[19]96/15/[0]4 (ydm)

[19]96/[04]/15 (ymd)

 

These time formats are acceptable:

14:30

14:30[:20:999]

14:30[:20.9]

4am

4 PM

[0]4[:30:20:500]AM

 

 

For MS Access:

 

Screen Snapshot:

 

 

 

Note: Format elements allowed are listed below this table.

 

Date format - Display:

Date format to be used for displaying dates.

 

Date format - Input:

Date format to be used for inputting dates. This will be the input mask against which date string will be validated.

 

Time format - Display:

Time format to be used for displaying time.

 

Time format - Input:

Time format to be used for inputting time. This will be the input mask against which time string will be validated.

 

 

 

 

Datetime Formats (Not captured on screen.)

DATETIME uses: DATE format + “ ”(blank) + TIME format.

 

 

 

 

Date/Time Display Preview:

Current date/time displayed using the formats stored before.

 

 

 

 

Currency Symbol:

Currency Symbol

 

Money format - Display:

Money data type format for Display

 

Float format - Display:

Float data type format for Display

 

 

****** Date Formats ******:

: - (colon) Time separator. Separators are set in the Regional Settings Properties dialog box in Windows Control Panel.

/ - Date separator.

c - Same as the General Date predefined format.

d - Day of the month in one or two numeric digits, as needed (1 to 31).

dd - Day of the month in two numeric digits (01 to 31).

ddd - First three letters of the weekday (Sun to Sat).

dddd - Full name of the weekday (Sunday to Saturday).

ddddd - Same as the Short Date predefined format.

dddddd - Same as the Long Date predefined format.

w - Day of the week (1 to 7).

ww - Week of the year (1 to 53).

m - Month of the year in one or two numeric digits, as needed (1 to 12).

mm - Month of the year in two numeric digits (01 to 12).

mmm - First three letters of the month (Jan to Dec).

mmmm - Full name of the month (January to December).

q - Date displayed as the quarter of the year (1 to 4).

y - Number of the day of the year (1 to 366).

yy - Last two digits of the year (01 to 99).

yyyy - Full year (0100 to 9999).

 

****** Time Formats ******:

h - Hour in one or two digits, as needed (0 to 23).

hh - Hour in two digits (00 to 23).

n - Minute in one or two digits, as needed (0 to 59).

nn - Minute in two digits (00 to 59).

s - Second in one or two digits, as needed (0 to 59).

ss - Second in two digits (00 to 59).

ttttt - Same as the Long Time predefined format.

AM/PM - Twelve-hour clock with the uppercase letters 'AM' or 'PM', as appropriate.

am/pm - Twelve-hour clock with the lowercase letters 'am' or 'pm', as appropriate.

A/P - Twelve-hour clock with the uppercase letter 'A' or 'P', as appropriate.

a/p - Twelve-hour clock with the lowercase letter 'a' or 'p', as appropriate.

AMPM - Twelve-hour clock with the appropriate morning/afternoon designator as defined in the Regional Settings Properties dialog box in Windows Control Panel.

 

****** Float/Money Format ******:

One of: , . 9 0 

 

 

For MySQL:

 

Screen Snapshot:

 

 

 

Note: Format elements allowed are listed below this table.

 

Timezone:

User’s timezone information. The DATE, DATETIME and TIME types displayed will be as per the timezone of user.

 

Specify in format: e.g.

Asia/Calcutta

 

 

 

Date format - Display:

Date format to be used for displaying dates.

 

Date format - Input:

Date format to be used for inputting dates. This will be the input mask against which date string will be validated.

 

Time format - Display:

Time format to be used for displaying time.

 

Time format - Input:

Time format to be used for inputting time. This will be the input mask against which time string will be validated.

 

 

 

 

Datetime Formats (Not captured on screen.)

DATETIME uses: DATE format + “ ”(blank) + TIME format.

 

 

 

 

Date/Time Display Preview:

Current date/time displayed using the formats stored before.

 

 

 

 

Currency Symbol:

Currency Symbol

 

Money format - Display:

Money data type format for Display

 

Float format - Display:

Float data type format for Display

 

 

****** Date Formats ******:

%a - Abbreviated weekday name (Sun..Sat)

%b - Abbreviated month name (Jan..Dec)

%c - Month, numeric (0..12)

%D - Day of the month with English suffix (0th, 1st, 2nd, 3rd, …)

%d - Day of the month, numeric (00..31)

%e - Day of the month, numeric (0..31)

%j - Day of year (001..366)

%M - Month name (January..December)

%m - Month, numeric (00..12)

%U - Week (00..53), where Sunday is the first day of the week

%u - Week (00..53), where Monday is the first day of the week

%V - Week (01..53), where Sunday is the first day of the week; used with %X

%v - Week (01..53), where Monday is the first day of the week; used with %x

%W - Weekday name (Sunday..Saturday)

%w - Day of the week (0=Sunday..6=Saturday)

%X - Year for the week where Sunday is the first day of the week, numeric, four digits; used with %V

%x - Year for the week, where Monday is the first day of the week, numeric, four digits; used with %v

%Y - Year, numeric, four digits

%y - Year, numeric (two digits)

 

****** Time Formats ******:

%H - Hour (00..23)

%h - Hour (01..12)

%I - Hour (01..12)

%i - Minutes, numeric (00..59)

%k - Hour (0..23)

%l - Hour (1..12)

%p - AM or PM

%S - Seconds (00..59)

%s - Seconds (00..59)

 

****** Float/Money Format ******:

If specified indicates number of digits after decimal point and enables display of value in thousand separator format like ###,###,###.##


nn - Number of digits after decimal point. e.g. 4 means display as ###,###,###.####

 

GUI/Screen Preferences section:

 

 

GUI/Screen Preferences:

Note: Color can be specified as name or hex code, e.g. Yellow, FF00FF, Pink, etc.

 

For Screen

 

 

Screen Background Color:

Screen Background Color

 

Font Name:

Font Name

 

Font Color:

Font Color

 

For Category

 

 

Category Background Color:

Category Background Color

 

Font Name:

Font Name

 

Font Color:

Font Color

 

Font Size:

Font Size

 

For WP Screen Menu

 

 

WP Screen Menu Background Color:

WebProject Screen Menu Background Color

 

Font Name:

Font Name

 

Font Color:

Font Color

 

Font Size:

Font Size

 

For EM Tables (other than WebForm)

* To be implemented in future release.

 

Table Color Scheme:

Table Color Scheme

 

Color 1:

Color 1

 

Color 2:

Color 2

 

Color 3:

Color 3

 

Table Border

Table Border

 

 

GUI/Screen Preferences continued…:

 

Page Layout and Session Settings Flags: Has checkboxes for following (disabling will not display that particular entity or disable that particular session setting on all screens):

 

Flag Name

Description

Header  

Display This part On/Off

Logo  

Display This part On/Off

Title  

Display This part On/Off

User Info  

Display This part On/Off

App Name Branch  

Display This part On/Off

Menu  

Display This part On/Off

Line Begin  

Display This part On/Off

Line End  

Display This part On/Off

Footer  

Display This part On/Off

App Menu Images  

Display This part On/Off

Frame App Menu Images  

Display This part On/Off

WP Scr Images

Display This part On/Off

App List Images

Display This part On/Off

Menu Image Help File - All

Display This part On/Off

"FILE type Images",

Display This part On/Off

"HYPERLINK type Images",

Display This part On/Off

"FILE type HTML Obj",

Display This part On/Off

"HYPERLINK type HTML Obj",

Display This part On/Off

"TEXT type HTML Safe",

Display This part On/Off

"TEXT type HTML Obj",

Display This part On/Off

"TEXT type HTML Editor",

Display This part On/Off

"DATE type Date Picker",

Display This part On/Off

"Custom HTML Safe",

Display This part On/Off

"Custom HTML Obj"

Display This part On/Off

Inbox Edit Mode - On  

 

App Run Edit Mode – Off

 

ContentApps/Collab ToFollow – Off

Restrict List & Searches To Users defined as ToFollow. See details below.

Use JQuery – On

Using JQuery For Pop-Up Menus, etc On/Off

Sharing, Publishing to TP Mode – On

Display sharing, publishing links On/Off

Semantic Tags in Display - On

Display This part On/Off

 

 

 

Defining ToFollow (TFL) Users For ContentApps & Collaborations :

 

Please use Inbox Menu : Applications : Auth Roles/Grants.

 

ToFollow (TFL) Lists:

  • Please create Auth Roles with Auth Type: “APPTFL”. The UserIds granted to this Role are your ToFollow Lists.

 

 

 

Header/Footer and System Menu properties:

Header/Footer Font Name: 

Menu Orientation [H/V]:

Menu Style [T/S(char)]:   

Menu Font Name:    

Menu Color Scheme:

  • Color 1:   
  • Color 2:   
  • Color 3:   
  • Color 4:   
  • Color 5:   
  • Color 6:   

 

 

User profile Submit Options:

 

NOTE: New values take effect at the next Sign-In. Use “Set Only For Session” button to apply updated values or just try out new values.

 

  • Submit: Submit button to update the record in database.
  • Set Only For Session: Sets the values presently on screen to current session. Does not save them.

 

 

Table and Forms: Default Properties/GLOBAL Updates

 

Table and Forms section lists options to view or change default Form and Field properties, and globally update form/field cosmetic properties.

 

Default Form Properties

Use this link to view or change default Form Properties. Please refer to chapter “EM Tables” section “WebForms:Edit:Form Properties” for description of screen information.

 

Screen Snapshot:

 

Default Form Properties Options:

Copy : Copy (Mark) for subsequent  Paste

Paste: Paste earlier Copy (marked) prop into Default.

 

Default Field Properties

Use this link to view or change default Field Properties. Please refer to chapter “EM Tables” section “WebForms:Edit:Field Properties” for description of screen information.

 

Screen Snapshot:

 

Default Field Properties Options:

Copy : Copy (Mark) for subsequent  Paste

Paste: Paste earlier Copy (marked) prop into Default.

 

GLOBAL Form Properties Update (Cosmetic)

 

Use this link to make global updates to ALL form cosmetic only properties.

 

Screen Snapshot:

 

  • A confirmation screen is displayed, with following caution notice and link to proceed with update.
  • WARNING: Global update is not reversible, DO NOT CLICK if unsure
  • Note: Cosmetic includes Border, Background Color, Cellpadding, Cellspacing, Font Name, Font Color

 

 

GLOBAL Field Properties Update (Cosmetic)

 

Use this link to make global updates to ALL field cosmetic only properties.

 

Screen Snapshot:

 

  • A confirmation screen is displayed, with following caution notice and link to proceed with update.
  • WARNING: Global update is not reversible, DO NOT CLICK if unsure
  • Note: Cosmetic includes Border, Background Color, Cellpadding, Cellspacing, Font Name, Font Color

 

 

Utilities

 

This section lists utilities that can be run.

 

 

Refresh Category Tree

 

This section lists utilities that can be run.

 

Refresh Category Tree (For ODBC type databases)

 

This option is used to refresh Category Trees for ODBC type databases MS SQL Server and MS Access.

 

  • Run this task, usually after the application or EM Inbox is at some completion level.
  • The Category Tree is updated to reflect current status of the tree. Any changes to categories as add/delete are not updated automatically and will require re-run of Refresh option.
  • Note: In case of large tree, Refresh can affect performance and take a while to complete.

 

Screen Snapshot:

 

The Refresh Category Tree screen has following information fields and options.

 

  • Refresh: Select the category tree to refresh. One of: “200: Inbox”, “300: Application”, “100: Trash”, “50: Archives”
  • Submit: Submit the refresh task.

 

 

 

Upload Menu & Images


This option allows uploading of My Menu, Menu Image Icons, Help Files, public profiles, etc for EM Inbox and applications. It also displays previously uploaded files.

Upload My Menu Screen options are:

·        File For :  

o       My Menu - Inbox

o       My Menu - AppRun (Apps, Content Apps)

o       App List - Image

o       App List - Help HTML File

o       App Menu (Category/Folder) - Image

o       App Menu (Category/Folder) - Help HTML File

o       WP Screen Menu - Image

o       WP Screen Menu - Help HTML File

o       Profile For Public 

·        EM Object Id:

o       For App List: App Category (Blank=0=Default) e.g. 0 or 200 or 100001 ...

o       For App Menu (Category/Folder): Category Id e.g. 100045

o       For WP Screen Menu : WPId_ScreenId e.g. 100030_100020

o       For Others : Leave blank

·        File: Browse the file from local desktop and click “Upload” button.

 

Existing Uploaded Files: Displays list. E.g.

** File : app0.html , Size [ 170] Bytes
** File : app0.jpg , Size [ 3364] Bytes
** File : app100002.jpg , Size [ 3364] Bytes
** File : app200.bmp , Size [ 6190] Bytes
** File : app200.html , Size [ 171] Bytes
** File : app200.jpg , Size [ 3364] Bytes
** File : ctg100002.html , Size [ 168] Bytes
** File : ctg100002.jpg , Size [ 3501] Bytes
** File : ctg100007.html , Size [ 168] Bytes
** File : ctg100007.jpg , Size [ 3502] Bytes
** File : DEMO.html , Size [ 10504] Bytes
** File : DEMO_AP_0.html , Size [ 39] Bytes
** File : DEMO_AP_100002.html , Size [ 2406] Bytes
** File : profpub.html , Size [ 168] Bytes
** File : wpj0.html , Size [ 167] Bytes
** File : wpj0.jpg , Size [ 3500] Bytes
** File : wpj100002_100002.html , Size [ 168] Bytes
** File : wpj100002_100002.jpg , Size [ 3500] Bytes
** File : wpj100002_100015.html , Size [ 168] Bytes
** File : wpj100002_100015.jpg , Size [ 3501] Bytes

Tip: There is no option to remove or delete uploaded My Menu file. Please upload a blank (zero size) file to replace previous file if the contents are not desired.

 

HTML Tag Restrictions in Uploaded “My Menu”:

 

For information on Display of HTML Tag Restrinctions, please refer to “HTML Tag Restrinctions” chapter.

 

 

HTML Tag Restrictions in Uploaded “App Help files” and “Public Profile”:

 

Allowed HTML Tags are:

·        Safe Cosmetic HTML Tags

·        Image Tags

 

Following HTML tags are not allowed in uploaded files for Help HTML App Help Files & User Profile. The file content while will be reset and warning displayed instead..

 

Comment

Tags

 

Restricted HTML Tags

"!DOCTYPE"

,"body"

,"frameSet"

,"head"

,"html"

,"xhtml"

,"?IMPORT"

,"base"

,"link"

,"meta"

,"title"

,"style"

,"frame"

,"noFrames"

,"frameSet"

,"baseFont"

,"link"

,"blink"

,"marquee"

,"keygen"

,"layer"

,"ilayer"

,"applet"

,"bgSound"

 

,"script"

,"noScript"

,"javascript:"

,"vbscript:"

,"about:"

,"res:"

,"embed"

,"object"

,"param"

,"xml"

,"?xml"

,"video"

,"audio"

"iframe"

,"button"

,"form"

,"input"

,"select"

,"option"

,"optGroup"

,"textArea"

 

 

 

 

Settings Menu (In App Run)

 

Options menu has sections and links to select different option screens as below.

 

Screen Snapshot:

 

Session Settings

  • Data Groups : Set Data Group preferences for session.
  • Update App Profile (Session) : Update User profile for current App Session. This is effective for the duration of session only (and not stored).
    • Please refer to “Member Account:Update User Profile” section for details
    • You can use “App Run Edit Mode – Off” checkbox un-click (i.e. enable Edit Mode) to be able to MarkSend the AppLinks on various screens.  
  • Tagging : Set tagging display preferences for session and view Tag Users.

 

 

 

Chapter 8: Using Images (Icons, Links) For EM Objects

 

This chapter details on how to use web graphics i.e. use menu icons and image links with different menus such as Application Lists, App Menu, App Scr Menu, etc.

 

 

Introduction

 

The menu icons and image links facility is provided to enhance and customize graphics look and feel of your application. You can use it stand-alone or along with Jsp file customizations (see chapter below).

 

General Notes:

  • This functionality requires that developer get access to directory where product is installed, so system administrator should be involved.
  • The icons and images are specified for given Object Ids, if you change objects (delete, copy, etc), the image files need to be renamed accordingly.
  • The images should be uploaded via “Options : Utilities : Upload Files”
  • The file naming convention is detailed with individual menu types.
  • There are parameters provided in /em/jsp/BaseEmPrtl.jsp to help you select how image links will be displayed.

 

 

 

Jsp Configuration Parameters For Image Menus

 

The parameters provided in file /em/jsp/BaseEmPrtl.jsp. They help you select how image links will be displayed at runtime. Any changes to parameters require that the Jsp Container Server needs to be shutdown and started again to take effect.

 

Following parameters are available:

 

 

Location and extensions

 

 

img_real_dir

Specify where product is installed i.e. parent directory where /em/index.html resides

Default: /emprod/emv50

 

img_file_ext

File Name extension for your icon/image files.

Default: “.jpg”

 

mnu_img_helpfile_ext

File Name extension for image help files.

Default: “.htm*”

 

 

 

 

Display Menu Image Flags

0=Off, 1=On

 

menu_images

Display App Menu (Categories, Folders) Images

 

fr_menu_images

Display App Menu Images and App Menu Screen Images in Left User Menu Frame

 

menu_scr_images

Display App Menu WP Screen Images

 

app_list_images

Display App List Images

 

 

 

 

Note: Following 2 NOT Implemented Yet:

 

 

sys_menu_images

Display System Menu Images

 

tbl_data_html_img

Display Table Data Image HTML Obj

 

 

 

 

Display Help HTML File Flags

1=On, 0=Display when no image, 2=Off

 

mnu_img_helpfile

Displaying of Help HTML file contents on Right along with Menu/Folder/App Image on Left

 

 

 

 

Miscellaneous Flags

 

 

menu_image_cols

Number of columns to be displayed for App Menu Images on Main Form.

 

Note: If Custom Images ON then set value to 1 column ONLY (and not 2 columns), As the hierarchy of tree will not be maintained with 2 cols.

 

 

 

 

Displaying of Text URL Links with Menu Image Links Flags

1=Always Display Text Link

0=Do not display Text Link if Image Icon is present

2= Always Off, Only display Image Icon Links or nothing if no image is associated

 

menu_img_txt_lnk

For App Menu Images

 

fr_menu_img_txt_lnk

For App Menu Images and App Menu Screen Images in User Menu Frame

 

app_list_img_txt_lnk

For App List Images

 

menu_scr_img_txt_lnk

For App Menu Screen Images

 

 

 

 

 

 

Image Links For Application List Menu

 

Has following considerations

  • Image Icon Naming Conventions: app<Category Id>
  • Where Category Id is the Application Tree Branch Id as present on Application registration Screen.
  • All the different application registration records for a “User ID - Category Id”  (combination of data group, access security) will get same image icon displayed. However the particular detail will be highlighted with image ALT tag.

 

 

Image Links For Application Menu (Folders)

 

Has following considerations

  • Image Icon Naming Conventions: ctg<Category Id>
  • Where Category Id is the Category Id as displayed on EM Object Explorer Screen.
  • Application Menu can be further customized, by specifying number of columns of menus to be displayed on main form. See jsp parameter above.

 

 

Image Links For Application (WebProject) Screen Menu

 

Has following considerations

  • Image Icon Naming Conventions: wpj<WebProject Id>_<Screen Id>
  • Where WebProject Id and Screen Id are as displayed on EM Object WebProject selection Screen. Screen Id needs to be is used and not Screen (Srl) Order Number.

 

 

Image Links In Frames User Menu

 

Has following considerations

  • The Jsp parameters controls both App Menu and App Screen Menu.
  • Same images specified as above are displayed in Frame Menu. However the Text Link Display control is provided separately. See jsp parameters above.

 

 

 

Chapter 9: Advanced Features

 

This chapter details on advanced features for developers like how to customize jsp files, use EM Script code at multiple places, etc.

 

 

Customizing Jsp Files

 

This section details on how to customize jsp files provided to enhance and customize graphics look and feel of your application. Special facility is given to customize key jsp files and keep them separate.

 

Enabling Usage of Jsp customize files:

Following parameter provided in file /em/jsp/BaseEmPrtl.jsp can enable usage of custom jsp files under /em/custom/jsp directory.

 

jsp_cust = 0; //0=Off, 1=On

 

Which files are available to customize ?:

Following files are available. Their names end with Custom. Please copy the contents of original file as given in custom file first and then customize.

ListAppsCustom.jsp

ListAppMenuCustom.jsp

ListAppScrMenuCustom.jsp

 

What about other jsp files? :

Customizing other files is at user discretion, However such changes are not supported or are supported with specific support option.

You can use User profiles to customize look and feel instead.

 

 

EM Script Code Processing

 

This section details on EM Script codes available and it’s processing locations.

 

Where & When ?

EM Script processing happens at multiple points. Following table highlights those points and the conditions when processing takes place.

 

 

Location

When Processing takes place

 

Form Properties : Enable Script ? (Script Code / FreeStyle HTML code)

“Enable Script ?” is Yes.

 

Field Properties : Script: Enable Script ? (Script Code)

“Enable Script ?” is Yes.

 

Field Properties : Field Prompt Properties: FreeStyle HTML code? (HTML Text)

“FreeStyle HTML code?” is set, not No.

 

Field Properties : Data Display Properties: FreeStyle HTML code? (HTML Text)

“FreeStyle HTML code?” is set, not No.

 

WebScreen Properties: Script or Custom Menu HTML:

“Script /C. Menu Position” is set, Not Blank.

 

WebScreen Properties: Before HTML text

“FreeStyle HTML?” Set to “Before” or Both”

 

WebScreen Properties: After HTML text

“FreeStyle HTML?” Set to “After” or Both”

 

For Advanced Users Only:

  • For following file inclusion tokens processing to take place the User must have Advanced User privileges.
    • [{IFP-file_path_name-IFP]}
    • [{IF-file_path_name-IF]}
  • All other tokens mentioned here are processed for all users.

 

 

Generic Tokens processed:

Following Generic Tokens are processed at all points given above. Their functioning is described below.

 

[{IFP-file_path_name-IFP]}

Include file and Process file contents for further EM Script. Use correct path e.g. [{IFP-em/custom/files/demo/file1.js-IFP]}

 

[{IF-file_path_name-IF]}

Only Include file.  (But do not Process file contents for further EM Script). Use correct path e.g. [{IF-em/custom/files/demo/file2.js-IF]}

 

 

Additional Token Processing:

Additional Tokens processed and their significant at specific circumstances as applicable:

 

Location

Specific Tokens For Location,

Effective When, Functioning

 

Form Properties : Enable Script ? (Script Code)

 

 

 

Effective in Display Mode:

 

 

[{RECNO-nn-RECNO]}

 

 

Overrides the number of records per form limit set by following conf params:

em.param.records_per_form

em.param.da_records_per_form

Such that the new value is permissible by:

Em.param.max_records_per_form

 

 

[{RINFO-YNYNYNYNYNYNYNYNY-RINFO]}

 

 

Filters the parts out of record info displayed. Up to 17 parts can be selected as below:

1 Brackets, 2 Actual Srl#, 3 Rec# Title, 4 Actual Rec#, 5 Data Grp:, 6 Actual DG, 7 App Usr:, 8 Actual AU, 9 Created:, 10 Actual Created Date, 11 Changed/By:, 12 Actual date and Chged By,

Links: 13 Edit, 14 Del, 15 Archive, 16 Copy, 17 RecInfo

 

e.g. YYYYNNYYYYYYNNYYY: will not display Data Grp. And Edit/Del links.

 

 

 

[{SCROL-nn-SCROL]}

 

 

Enables a Record Scroll Bar on form.

Where nn should be > 0.

Use this value (e.g. 1,2,3,4…) to customize display of scroll bar in jsp file.

See “Record Scroll Bar” for more details.

 

 

Effective in Input/Edit Mode:

 

 

[{MULTITAB]}

 

 

Only Applicable and Useful For NormalLayout, Input Mulit Record Mode:

Special token for Multiple record Input form displayed as spreadsheet contiguous lines (1 record input per line) for NormalLayout Mode only.

 

Make sure the Form orientation is “NormalLayout” and Layout is set as generated by Tabular button, otherwise dis-organized screen may display.

 

Without this token, multi record input lines are not contiguous.

 

 

[{NOSUBBTN]}

 

 

Omits the “Submit” and “Reset” buttons. For use when form.submit() needs to happen via JavaScript.

 

 

[{DISPMODE]}

 

 

Display Mode i.e. Omits the “Submit” and “Reset” buttons and FORM tags.

 

Field Properties : Enable Script ? (Script Code)

 

 

 

Effective in Input/Edit Mode:

 

 

[{DISPTEXT]}

 

 

Instead of input field display it’s text and make the field hidden.

 

 

[{HIDDEN]}

 

 

Instead of input field display no text and make the field hidden.

 

 

Effective in Display Mode:

 

 

[{KEEPVAL]}

 

 

Field value is displayed and a hidden field is kept.

 

 

[{KEEPHIDE]}

 

 

Field value is NOT displayed and a hidden field is kept.

 

WebScreen Properties: Script or Custom Menu HTML:

 

 

 

Effective for that specific WebScreen Exec:

 

 

[{MINTAGS]}

 

 

For Use of web page as PORTLET.

Put HTML text after and before tags: BODY /BODY (excluding these tags)

Note: No SysMenu is displayed.

 

 

[{NOSYSMENU]}

 

 

No SysMenu is displayed.

 

 

[{NOTITLE]}

 

 

No WP Screen Title and Sub-Title is displayed.

 

 

[{WPM-n-WPM]}

 

 

WP Menu Line Parts Enabling flag:

Where n should be > 0.

0 : Print all contents

1 : Hide all contents

 

>= 2 : Print Prev menu

>= 3 : Print next Menu

>= 4 : Print [W] MENU

 

 

 

[{TAG-flag-TAG]}

 

 

Tagging Related:

 

 

Format:

[{TAG-<flag1|flag2|…>-TAG]}

Where 1 or more flags can be specified:

 

TagMenuOff – Do not add TagMenu Link

 

TagDispOff – Do not display any Tags

 

TagDispNoAdvTag – Only display Simple Tags (Hides TagPlus data of Advanced tags as well.)

 

TagDispIgnoreWPNo - Display tags from other WP projects with any Wp Scr using same table id. Applies to getting only Simple Tags from other WP.

 

TagDispNoAdvTag & TagDispIgnoreWPNo – These can be used together: So that only simple tags all across WPs are displayed.

 

e.g.:

[{TAG-TagMenuOff-TagDispOff-TAG]}

 

[{TAG-TagDispNoAdvTag-TagDispIgnoreWPNo-TAG]}

 

[{TAG-TagMenuOff-TagDispNoAdvTag-TagDispIgnoreWPNo-TAG]}

 

[{TAG-TagDispNoAdvTag-TAG]}

 

WebScreen Properties: Before HTML text:

 

 

 

Only Generic tokens.

 

 

 

 

WebScreen Properties: After HTML text:

 

 

 

Only Generic tokens.

 

 

HTML Tag Restrictions in Script Processing:

 

For information on Display of HTML Tag Restrinctions, please refer to “HTML Tag Restrinctions”.

 

 

HTML Tag Restrictions

 

 

HTML Tag Restrictions - Display HTML Object For TEXT:

 

Different settings are allowed for Display HTML Object For TEXT type.

Display of HTML tags are governed by setting of conf parameter:

em.param.em_disp_htmlObj [Loc 3]

 

HTML Tag Restrictions - Custom HTML:

 

Different settings are allowed for Custom HTML at following locations:

·        Form and Field Properties

·        WP Screen Properties

·        My Menu

·        Uploaded App Help Files

·        Profile Public

 

Note: Setting Levels as per conf param For Following locations are not implemented yet:

·        Uploaded App Help Files

·        Profile Public

 

Display of HTML tags are governed by setting of conf parameter:

em.param.em_enable_cust_html

 

HTML Tag Restrictions - Details:

 

Each location can set level of HTML Tag enabling as below, levels are incremental and include lower level tags as well:

·        0=No : Disable ALL Tags

·        (1+) = yes

·        1= Yes Safe Html and URL Links (A HREF)

·        2= Images (img, map, area)

·        3= iframe tag

·        4= video, audio, xml, object, embed

·        5= script tag

 

If the User does not have Advanced privileges, then Level 5 (Script Related) HTML tags are not allowed in code and disabled.

 

HTML Tags enabled as per Levels:

Level

Comment

Allowed Tags

1

Safe HTML and URL Links (A HREF)

"a"

,"center"

,"div"

,"fieldSet"

,"legend"

,"dd"

,"dl"

,"dt"

,"dir"

,"li"

,"listing"

,"menu"

,"ol"

,"ul"

,"caption"

,"col"

,"colGroup"

,"table"

,"tBody"

,"td"

,"tFoot"

,"th"

,"tHead"

,"tr"

,"abbr"

,"acronym"

,"address"

,"cite"

,"code"

,"dfn"

,"em"

,"kbd"

,"samp"

,"strong"

,"var"

,"b"

,"big"

,"blockQuote"

,"del"

,"H1"

,"H2"

,"H3"

,"H4"

,"H5"

,"H6"

,"i"

,"rt"

,"ruby"

,"s"

,"small"

,"span"

,"strike"

,"sub"

,"sup"

,"tt"

,"u"

,"xmp"

,"bdo"

,"font"

,"ins"

,"p"

,"plainText"

,"pre"

,"q"

,"br"

,"hr"

,"nobr"

,"wbr"

,"isIndex"

,"label"

,"!--"

,"comment"

2

Images

"img"

,"map"

,"area"

3

Iframe

"iframe"

4

video, audio, xml, object, embed

"embed"

,"object"

,"param"

,"xml"

,"?xml"

,"video"

,"audio"

5

Script

,"script"

,"noScript"

,"javascript:"

,"vbscript:"

,"about:"

,"res:"

 

HTML Tags disabled at ALL time:

Level

Comment

Tags

All

Disabled HTML Tags

"!DOCTYPE"

,"body"

,"frameSet"

,"head"

,"html"

,"xhtml"

,"?IMPORT"

,"base"

,"link"

,"meta"

,"title"

,"style"

,"frame"

,"noFrames"

,"frameSet"

,"baseFont"

,"link"

,"blink"

,"marquee"

,"keygen"

,"layer"

,"ilayer"

,"applet"

,"bgSound"

 

 

 

Record Scroll Bar

 

This section details on Record Scroll Bar displayed and it’s fields. Form Script Token [{SCROL-nn-SCROL]} will enable a scroll bar to be displayed. Where nn should be greater than (>) 0. Use this value (e.g. 1,2,3,4…) to customize display of scroll bar in jsp file.

 

NOTE: Multiple Scroll Bars on one page is not supported for use, as with DisplayCombined Mode of WebScreens, it will not function properly.

 

The scroll bar holds the list of record numbers fetched by the query in JavaScript Array. Record List navigation is allowed on Left and Right. Current record can be displayed or Edited in a new window (invoked on first use).

 

It has following information fields and options.

 

 

Scroll Bar [nn]:

Where nn=type no. Use for customization.

 

Total#

Total no of records fetched by query.

 

Srl#

Current Record Srl No. in Record List

e.g. 1,2,3,4…

 

Set Of

For Grouping records. e.g. Set Of 10, 5, …

Default is 10, Change the no when displayed as per your needs.

 

|<

Navigate to First record in Record List

 

<<

Navigate to Left by Set no. in Record List

 

<

Navigate to Left by 1 record in Record List

 

Cur Rec#

Current actual Record No.

 

View

Button to View the current record

 

Edit

Button to Edit the current record.

 

View Set

Button to View the set no. of records starting from current record

 

>

Navigate to Right by 1 record in Record List

 

>>

Navigate to Right by Set no. in Record List

 

>|

Navigate to Last record in Record List

 

 

Customize following jsp files to change scroll bar looks or functionality:

/jsp/dn/sub_data_frm_ins_scrollbar.jsp

 

 

 

Chapter 10: FAQ’s / How To’s?

 

This chapter details on some of the frequently asked questions and/or commonly faced issues and their answers solutions when using Studio.

 

 

Fetch Back Multiple Values from Look-Up

 

To fetch-back multiple values from the Look-Up screen e.g. when you want to select Ledger Code and also get back Ledger Name, do following.

 

By default an empty function doEmLookAddTask(rec_srl) is called from the Look-Up screen when value is selected. You can override this with new function.

 

On the Look-Up Screen, Use [{KEEPVAL]} token in Field Script to generate a hidden field for each record. And override the default function as below. On the calling screen you can use an existing other field or newly out input field to assign additional values from look-up:

 

<SCRIPT language="JavaScript">     

function doEmLookAddTask(rec_srl) 

{                      

   var t1 = rec_srl; //nothing by default

eval("opener.document.FI10010.F10031.value = document.FV10010.F10031_"+rec_srl+".value;");

}

</script>

 

 

Implement Master-Detail Input/Edit Screens

 

To implement master-detail type of input or edit screens:

Define separate WebScreens for each section.

Use form token [{NOSUBBTN]} to disable individual form submit buttons.

Now use a custom html page defining 3 frames. Assign WebScreen execute URLs to first 2 frames and 3rd frame will contain a button to execute form.submit() for each frame.

 

Custom HTML programs:

/em/file1.htm:

<html>

<head></head>

<FRAMESET rows="*,20%">

<FRAMESET rows="50%,*">

<FRAME src="/em/jsp/dn/webproj_exec.jsp?usrnm=DEMO&wp_id=10006&screen_num=1">

<FRAME src="/em/jsp/dn/webproj_exec.jsp?usrnm=DEMO&wp_id=10006&screen_num=2">

</FRAMESET>

<FRAME src="/em/file2.htm">

</FRAMESET>

</HTML>

 

/em/file2.htm:

<html>

<head>

<script language="javascript">

function doSub()

{

      parent.frames[0].document.forms[0].submit();

      //window.confirm("ok?");

      parent.frames[1].document.forms[0].submit();

}

</script>

</head>

<body>

<form>

<input type=button name=sub1 value="SUB_ALL_FORMS" onClick="doSub();">

</form>

</body>

</HTML>

 

 

JavaScript Calculations in Input|Edit<Multi> Modes

 

On input|edit<Multi> screens:

The fields are named with row number in beginning e.g. M<RowNo>Field Id. Following example shows how to assign javascript event functions onblur to fields. The functions calculate price after item rate and quantity is entered. Assign the script code to WP Screen “Script or Custom Menu” with position of “End”. So that when this gets executed the forms fields are in place.

 

Note: When not using frames omit from code: parent.frames[1]

 

<script language="javascript">

function doItemPrc1() { doItemPrc(1); }

function doItemPrc2() { doItemPrc(2); }

function doItemPrc3() { doItemPrc(3); }

function doItemPrc4() { doItemPrc(4); }

function doItemPrc5() { doItemPrc(5); }

function doItemPrc6() { doItemPrc(6); }

function doItemPrc7() { doItemPrc(7); }

function doItemPrc8() { doItemPrc(8); }

function doItemPrc9() { doItemPrc(9); }

function doItemPrc10() { doItemPrc(10); }

//...

//cntd. till MultiRec total.

 

function doItemPrc(i)

{

      //var i = "1";

      eval ("parent.frames[1].document.forms[0].M"+i+"F10939.value = parent.frames[1].document.forms[0].M"+i+"F10935.value * parent.frames[1].document.forms[0].M"+i+"F10936.value; ");

      //calc total of sale here...

}

function doInit1()

{

      //M1F10936 = Rate

      var l_mrec =  parseInt( parent.frames[1].document.forms[0].multirec.value);

      for (var i=1;i<=l_mrec;i++) {

      eval ("parent.frames[1].document.forms[0].M"+i+"F10936.onblur = doItemPrc"+i+";");

      }

}

      doInit1();

</script>

 

 

Advanced Uses of WebScreen CallBean Mode

 

WebScreen CallBean mode is useful for custom programming. Although CallBean indicates calling a java bean, only jsp file also can be used without bean.

 

Making a database connection:

Include jsp file

/custom/jsp/DbConnect.jsp

 

Following Jsp file shows how to use DbConnect.jsp and make custom call to fetch data.

/custom/jsp/CB_DEMO_10006_10038.jsp

 

Following Jsp file shows how to use mimic a query form submission to fetch data records , setting p_tblqry = 1 will fetch all records:

/custom/jsp/CB_DEMO_10006_10038_ins1.jsp

 

 

 

How to use multiple (Ora, Msq, Access) db conn

 

If the license allows users can switch database type before connections using switchDbConnType function. This call should follow the jsp:useBean tag. The rest of parameters you pass to sub_data_frm should be valid in the target db conn. E.g. When using access database, if you want to fetch data from MS SQL, use following:

 

<jsp:useBean id="sdks" scope="page" class="em.sub_data_frm" />

<%

      sdks.switchDbConnType("mssql");

 

      sdks.WpSetConn(dbconn);

. . .

 

 

 

How to invoke specific application after Sign-In

 

To implement this:

Use a separate Sign-In html page.

Invoke a copy of signin.jsp with target URL to your own page which has specific application form displayed. Then auto-submit the form via javascript.

 

 

How to Trim Menu/Screen Names

 

e.g. Trim to 10 char: to display “Full Menu Na…” instead of “Full Menu Name”

 

To implement this:

Customize following jsp files

categ.jsp, webproj.jsp , APwebproj.jsp, APcateg.jsp

 

Take a look at EmFramesUsrMenu.jsp, EmFramesUsrMenuWP.jsp for info on using custom functions.

 

 

How to use custom style for HTML

 

To implement this:

Customize following jsp files

EmStyleDef.jsp

 

Also use EM Script Code to write specific style at different places.

 

 

Chapter 11: Using Applications

 

This chapter details on usage of applications by users.

 

 

List Applications

 

Before users can use an application, they:

  • Either need to subscribe to the Application via “Studio: Application Subscribe Menu”.
  • Or need to be pre-granted Authorized application access by App Owners.

Please refer to Studio User Guide for the details.

 

This screen lists applications A] Authorized and B] subscribed to and available to run, and allows to “Select” an application to run from these 2 lists.

 

Screen Snapshot:

 

List Application screen has following information fields and options:

 

Select Authorized Application section has following information fields and options:

 

·        Application Name: The application’s name. This is the User Name supplied on User Registration data by App Owner.

·        Application Id: The application owner’s User Id.

·        Num Id: The application auth role id number.

·        First Screen: One of: Default, Search, MyMenu.

·        Run:  The select button.

 

 

Select Subscribed Application section has following information fields and options:

 

·        Application Name: The application’s name. This is the User Name supplied on User Registration data by App Owner.

·        App Brach/Role: The information on app branch or authorization role.

·        Application Id: The application owner’s User Id.

·        Data Group: The application data group.

·        Access Id: The application subscriptions record id number.

·        Level: The application level.

·        Category Id: The application branch category id or zero (0) if none.

·        Access String: The application access permitted string.

·        First Screen: One of: Default, Search, MyMenu.

·        Run:  The select button.

 

 

Run Application

 

When an application is selected to run, the screen displayed has following information and options.

 

Screen Snapshot:

 

Run Application: Explorer screen has following sections, information fields and options:

 

Application EM Header Section:

 

·        Application: The application owner’s User Id.

·        Inbox/App: The application owner’s User Id.

·        Data Group: The application data group.

·        Sign-In User: The signed-in user’s User Id, this is application user.

·         

·        Application Name: The application’s name. This is the User Name supplied on User Registration data by App Owner.

·        App Brach/Role: The information on app branch or authorization role.

 

 

Application EM Menu Section:

 

Application EM Menu consists of following modules and menu options:

 

  • App Menu: Allows navigation and selection of EM Objects such as App Folders, WebProjects, etc. Depending upon the ‘first screen’ option selected upon application run, one of: App Explorer, App POWER Search or My Menu screen is displayed.
  • Settings
  • Search
  • Exit App: This link allows to switch to a different application. Implicit App Sign-Out is done.
  • Sign Out: Menu option for signing out of present app and session.
  • Help: For help screens.

 

 

Run Application: App Explorer, App POWER Search, My Menu

 

App Explorer: is similar to EM Inbox explorer, except that no object manipulation options like Edit/Del/etc are displayed.

 

App POWER Search: is similar to EM Inbox POWER Search, the search retrievals are limited according to access permitted to the application user.

 

My Menu: is customized menu for this application. The My Menu file name consist of App Owner Id, “_AP_”, and Category Id (300 for default no category selection).

 

 

Run Application: AppLinks Session All Received

 

AppLinks has following Menu Links /screens:

 

AppLinks(Sess

Displays App links marked in current session.

 

All  

Displays App links marked in all (current and previous) sessions.

 

Rcvd)

This screen has utility to Paste copied Applinks from email and then on next screen the URL links will be displayed which can be clicked/selected.

 

 

Run Application: WebProject Display

 

When a WebPorject is selected in “Application Run”, the screen displays a WebProject menu consisting of List Of WebScreens as links and Type of form (Input, Display,..) and Query Option.

 

Screen Snapshot:

 

 

Chapter 12: Portal (Direct Access URLs)


This guide describes the Portal features for developers and users.

 

Portal Home and Portal Search links are available on welcome screen under Portal 5.0.

While Portal Home link is the way to define your own portal home page, portal search is detailed below.

 

 

Portal Home

 

Portal Home link is the way to define your own portal home page. Administrator: Please modify the blank page to add Portal specific content and links.

 

 

Portal Search

 

This section explains on how to use portal search features listed as Portal Search link on welcome screen.

 

Use this screen to search for User/Application/Web Pages marked for Portal Access, i.e. access to portal components.

 

The portal search allows to search on User Info and WebProject screens only when explicitly marked so. Following must be done to enable portal search:

  • On User Registration Data, set  “Allow Portal Search ?” = “Yes”, and
  • On each WebProject Screen to enable, set  “Portal Access ?” = “Allow”.

 

Screen Snapshot: Portal Search

 

Search Form section has following information fields and options:

 

·        Check Application/User Info: Drop-down one of: “--Do Not Check--”, (Any Below), App/User Id,  App/User Name, App/User Keywords. If specified searches for EM User Id or EM User Name or Kewords.

·        Check Web Page Info: Search For: The search parameter value.

·        OR, Display All: Click this box to ignore parameter value but display all matching records.

·        In: Screen Title or Sub-Title.

·        Limit Rows: One of: 20, 50, 100, 300, 500, 1000, 1500, 2000, 100000

·        Submit: Form Submit button.

·        Check Web Page Advanced: Drop-down one of: “--Do Not Check--”, (Any Below), Title, Sub-Title, Title(Short), WP Keywords, Custom HTML. If specified searches for respective property of portal web screen.

·        Like: The search parameter value for above.

·        Common Parameters: Refer to section before.

 

Search Result Screen will display following information:

 

Screen Snapshot: Search Results Portal Search

 

  • WP Id#: WebProject ID number.
  • Screen Number: WebProject Screen number.
  • Screen Title: Title of WebScreen.
  • Screen Sub-Title: Sub-Title of WebScreen.
  • App/User Id: User Id.
  • App Name: User or App Name.
  • Created/Updated: Date when created/updated.
  • Select: Link to select the WebProject screen.

 

 

 

Chapter 13: Using Dashboards

 

This chapter explains on how to use dashboards available for the EM installation.

 

 

Dashboard 1

 

If selected in Sign-In, Dashboard 1 is displayed with additional frames for quick navigation. Following section explains some example frames and options that can be available.

 

Frame Levels

 

Frame Level 0: Dashboard:  

Frame Level 1: Sites & Services:  

Frame Level 2: Networks & Apps:

 

Dashboard 1 Options and Menus

 

Dashboard:  

[+] Inbox (Default)  

[+] This Site  

[+] Featured Sites  

[+] Help 

 

 

[+] Inbox (Default)  

 

Sites & Services:  

[-] Inbox (Default)  

 

Inbox :

    [-] User Srh

    [-] POWER Srh

    [-] My Menu

Apps :

    [-] List Apps

    [-] Content List Apps

    [-] Auth Define

Mail Box :

[-] Check New

    [-] AppLinks Sess All

    [-] MailComp Sess All

    [-] Search Mail

Collaboration:

    [-] Owned & MyCopy

    [-] Subscribed

    [-] List Auth/Pub.

Options:

    [-] User Profile

    [-] Upload Menu & Images

 

 

[+] This Site  

 

Sites & Services:  

[-] This Site (Public)

 

 

Note: Selecting public access links below will Sign you Out from your Inbox.

 

User Srh:

    [-] User Search

Portal Srh :

  [-] Your Direct Access URLs

  [-] All Direct Access URLs

Apps Content (Public) :

  [-] Content App List

Collaboration Srh:

  [-] Public Col.

 

 

[+] Featured Sites  

 

Displays featured sites and services.

 

 

[+] Help 

 

Displays website’s Help screen.

 

 

Chapter 14: Content (Applications - Content Type)

 


This section describes the Content Services features for developers and users.

 

Content App Home and Content App Search links are available on welcome screen under Content Services 5.0. While Content Home link is the way to define your own Content  home page, Content search is detailed below.

 

 

 

Managing Content

 

 

You can manage content originating in applications and system files. To make your application as content source, create an application registration of type “Content[Type]”. Please refer to Application Registration screen for details.

To define system files as content source, create a table with datatype FILE, and link the system files to data records of this table as content server file link.

 

ContentApp (Menu Items in Inbox->Applications)

 

 

This chapter explains on how to use Content App features and Content search features listed under Content Menu in Inbox.

 

The types of Apps searched from within Inbox:

  • ContentSpecUser : Where you have been granted access via direct or via a Group (Network, Group) you belong to.
  • ContentAuthUser : Where all registered users have access.
  • ContentPublic and ContentAnyUser : Where any user (even non-registered) have access.

 

 

Content App List

 

Use this screen to search for list of available Content (Content[Type] of applications) defined by developers and application owners.

 

Unlike search screen, this will directly list all available apps which can be selected and “Run”.

 

 

 

Content App Search

 

Use this screen to search for Content i.e. Content[Type] type of applications defined by developers and application owners.

 

The Search is allowed on

  • Content App Owner’s Info (User Id, User Name, Keywords).
  • The Categories (Folders, Menus) in this app.
  • Dates criteria, The Categories created or updated in specified date range.

 

The query results will display matching Content type app. Once you locate the content the access is allowed to it just as you access EM Applications. Just select and “Run” it to enter the selected app.

 

 

 

Applications (Content Type, Public Access)

 

This chapter explains on how to use Content App features and Content search features listed under Content section on welcome screen.

 

The types of Apps searched:

  • ContentPublic and ContentAnyUser : Where any user (even non-registered) have access. ContentAnyUser will ask you to enter your name or email.

 

 

Content App Home

 

Use this screen to navigate pre selected Content related links by your site administrator.

 

 

Content App Search

 

Use this screen to search for Content i.e. Content[Type] type of applications defined by developers and application owners.

 

The Search is allowed on

  • Content App Owner’s Info (User Id, User Name, Keywords).
  • The Categories (Folders, Menus) in this app.
  • Dates criteria, The Categories created or updated in specified date range.

 

The query results will display matching Content type app. Once you locate the content the access is allowed to it just as you access EM Applications. Just select and “Run” it to enter the selected app.

 

 

Content App List

 

Use this screen to search for list of available Content (Content[Type] type of applications) defined by developers and application owners.

 

Unlike search screen, this will directly list all available apps which can be selected and “Run”.

 

 

 

Chapter 15: Search

 

This guide section describes Search features for developers and users.

 

 

Search

 

 

The Search Feature provides for universal search of applications, portals, content, objects and data.

 

Search Options: Portal Search | Content Search | Collaboration Search

 

Following search options are available after Sign-In:

Multi-App Search: Search for menus, keywords, application owner info among multiple applications.

POWER Search: Search for menus, web screens, form fields, data values within one application.

 

 

Portal Search

 

Please refer to respective chapters for details on this option.

 

 

Content Search

 

Please refer to respective chapters for details on this option.

 

 

Collaboration Search

 

Please refer to respective chapters for details on this option.

 

 

Multi-App Search

 

Use this screen to search for menus, keywords, application owner info among multiple applications.

 

The Multi-App Search Form is similar to Content Search Form. Once you select an application record from the displayed list, an application run options screen (displaying different application subscription records) is displayed. Once you a select a particular subscription record, access is allowed to it just as you access EM Applications.

 

 

POWER Search

 

Please refer to respective chapters for details on this option.

 

 

Search Mail

 

Please refer to respective chapters for details on this option.

 

 

Search Collaborations

 

Please refer to respective chapters for details on this option.

 

 

Latest Activity (Search)

 

Please refer to respective chapters for details on this option.

 

 

 

Chapter 16: Portal Plus Features

 

 

Following special features are provided for deployment of products as portals.

 

 

Granting Access to Groups

 

You can grant access to an application defined as ContentSpecUser to a Network or Group entity and the access is propagated to all the members belonging to this entity.

 

Note: This feature is available with only Oracle. Please check it’s availability with other databases with our support.

 

Blocking Users

 

Individual users in the portal can block other individual users when both users are peer users in an application. For example application App1 has given access to User1 and User2. User1 can block User2 for this application (or globally all application). Then User2 can not view the records owned by User1.

 

Note: This feature is meaningful only in applications granting only “Read and Add” authorization to it’s users. If you allow Edit or Del then blocking user doesn’t make much sense. One can just delete the records entered by other users.

 

 

EM WebPlus Collaboration 5.0


This guide describes Collaboration features for developers and users.

 

Collaboration provides functions and features for communication, and to share a application, project, documents, task lists among a group of users. EM Mail is powerful tool to package your application and data in e-mail.

 

 

Chapter 1: EM Mail

 

This chapter explains on how to use EM Mail i.e. application data exchange via e-mail. It covers sections like EM Mail Compose, Create, Delete, Organize, Folders, Import, etc. At present available for Developer or EM Inbox Owner users.

 

 

Types Of Mail

 

There are 2 types of mail as below:

 

EM Mail

EM Mail is a special mail which is described in detail below.

 

Mail - Normal Email

Is any normal email received and imported in EM Mail Box via Check Mail.

 

 

What is EM Mail ?

 

 

EM Mail - In Brief

EM Mail is a unique feature to compose a special communication consisting of application definition as well as application data and wrap it up as e-mail (with attached files). Whereby the receiver can import the application and/or data and has the ability to view, run, reply or manipulate it as per his needs.

 

It is very simple to use and users have to just point-and-click to mark the objects and them compose EM Mail.

 

In a nutshell, it offers ability to exchange applications as well as data over internet at ease and is a quantum leap from traditional e-mails.

 

 

EM Mail has following considerations:

 

EM Mail Record

EM Mail record is created by Compose or via Create Mail options.

 

Outgoing Mail

Mail Compose will create Mail record, generate the mail files comprising of marked EM Objects and table data (EM tables only). The mail files use XML format convention.

 

Incoming Mail

Incoming mail folder holds mail received from POP accounts.

 

Mail Files

There are three types of files.

·        Control File: Named as [Mail Id]_P0.EMM

  • Part File: Named as [Mail Id]_P[PartNumber].EMM
  • DATA file (FILE datatype): Named as [Mail Id]_P[PartNumber]_DAT.EMM

The files can be downloaded or uploaded by users. Uploading of only EM Server created and same type (to-type) mail files without any modification is supported.

 

Note: Release 5.0 has implemented only Part 1 interface, i.e. multiple parts are not supported yet. So there will be only three (3) files associated with mail.

 

 

Mail Type

EM Mails are classified into two types IN/OUT. IN: received mail, OUT: outgoing mail. It is just a convention used and not enforced. Mails of type OUT can be imported as well.

 

Folder

EM Mail has 3 default folders: Outbox, Inbox, Trash. They are created upon need if not exists. Users can create other new folders by “Mail - Move” option which allows to select an existing folder or specifying new folder, which gets created.

 

Imported Mail (in New Sub-Inbox)

EM Server creates a new EM Inbox for imported mail using User ID as “EMMAIL” + Mail Id. Sign-in to this EM Inbox is allowed only via “View Imported” option. EM User Sign-In will not work.

 

 

 

Mail Box – Menu

 

Mail Box menu has sections and links to select different EM Mail screens as below.

 

Screen Snapshot: Mail Box - Menu

 

 

Mail Box Options (On Sub Menu)

·        Mail Box

  • Inbox (Mail)
  • Imported Mail
  • Folders
  • Outbox
  • Check Mail
  • Search Mail

 

Mail Box Options (On this screen)

 

  • Create New Mail( In   Out )
  • Compose Session  All
  • AppLinks Session  All

 

 

Compose (Session - All)

 

Use this screen to compose/create EM Mail from earlier marked objects.

 

Mail is of type OUT and is stored in folder “Outbox”. The folder is created if doesn’t exists. A new Mail Id is generated for created mail.

 

Compose Session

This menu option will select the objects marked in present session only.

 

Compose All

This menu option will select the objects marked in all sessions including present one. The screens and options displayed are same.

 

The markings for Compose can be cleared from EM Inbox - Explorer screen link options: ClearSend: Sess  All.

 

Note: Please make sure you have selected appropriate Selection Level (Tree/One Level) for Explorer Type markings.

 

 

Screen Snapshot: EM Mail - Compose

 

Compose Mail Screen has following information fields and menu options.

 

 

 

Marked For Send Info:

 

 

Type

One Of:

Explorer = Marked in EM Inbox -  Explorer as a category.

Object = Marked in object menu e.g. Table, WebProject, etc.

 

Send Object

Details EM Object type and name.

For Oracle database: Lists the complete sub-tree of folder (txt) type object, as well.

 

Id

Object Id.

 

Object Info

Applies only to “Object” type markings. Gives following info as applicable:

[ Parent Id, Form Id, Query Id, Data Record Id, WebProject Id, WP Screen Id, App Id]

 

User Info [Inbox/App DataGrp Sign-In]

Applies only to “Object” type markings. Gives following info as applicable:

User Id, Data Group, Sign-In User Id

 

 

 

 

Selection Options For Explorer Type:

 

 

Selection Level

One Of: Tree/One Level. Where,

Tree = Select the complete tree of each explorer marked folder (txt) type object.

One Level = Select only the explorer marked folder (txt) type object.

Note: Duplicate selections with equal or lower object level markings are ignored.

 

Object Level:

 

 

Table

One Of:

None = Do not select object definition.

Field Definition = Select field definition info.

Form Properties = Select form definition info.

Query = Select query definition info.

Keys = Select key (unique/foreign) definition info.

Joins = Select table join definition info.

Data = Select table data (excluding FILE type).

Data File Type = Select table data with FILE type as well.

 

 

Note on Data Records selection: Only data records of EM Table [DEF] with No or partial links to database are selected. Linked table data from actual database tables is not handled.

 

Option “Data File Type” is available if the following configuration parameter allows for it:

em.param.em_app_mail : DisableFILE_MailComp

 

WebProject

One Of:

None = Do not select object definition.

WebProject Definition = Select WebScreens info.

 

Application

One Of:

None = Do not select object definition.

Profile Info = Select application profile info.

Registration Info = Select application registration record info.

 

 

Note: Selecting Application: Registration Info - will capture your application registration and subscription authorization tokens (passwords) as well in mail.

 

Compose Options:

 

 

Packaging

Number of parts. Implemented as only “Single”.

 

Package Size

Size of each part. Not implemented yet.

 

Subject

Subject Line info.

 

 

NOTE:

Restrictions on Data Content For non-FILE data types:

  • The character sequence "]]>" must not appear in field values (content) for any of the above data types, else Mail Import will fail later on.

 

 

AppLinks (Session - All)

 

Use this screen to view marked App Links from earlier marked objects in app run mode.

 

Session

This menu option will select the objects marked in present session only.

 

All

This menu option will select the objects marked in all sessions including present one.

 

The markings for AppLinks Compose can be cleared from EM Inbox - Explorer screen link options: ClearAppLinks: Session  All.

 

 

Screen Snapshot: EM Mail - AppLinks

 

 

Note: Please do NOT click on these links (since links are for app run mode and you are in Inbox) else you will get signed-out. Select them with mouse and Copy (to later on Paste somewhere, e.g. to send via email).

 

AppLinks Screen has following information fields and menu options.

 

 

 

Marked For Send Info:

 

 

App Id

User Id for Application

 

AppLinks

Listing of links for App Id.

Links are for One Of the types:

[E] Folder/Menus

[W] WebProjects

[WpScr] WebProject Screens

[DataRec] WebProject Display Type Screen Data Record

 

 

 

 

Create Mail (In - Out)

 

Use this screen to create a blank EM Mail of given type. The links In or Out are just for convenience, type can be changed on form. Mail type IN is stored in folder “Inbox” while type OUT is stored in folder “Outbox”. These folders are created if don’t exists. A new Mail Id is generated for created mail.

 

 

Screen Snapshot: EM Mail - Create

 

Create Mail Screen has following information fields and menu options.

 

 

Mail Type

Mail type drop-down, select one of: IN/OUT.

 

From

From Info.

 

To

To Info.

 

Subject

Subject Line.

 

 

 

View EM Mail List - Inbox (Mail), Outbox, Selected Folder

 

EM Mail uses this generic screen to view EM Mail list as applicable, i.e. Inbox (Mail), Outbox, etc.

 

Following Screens use EM Mail List:

  • Inbox (Mail): displays mails in folder “Inbox”.
  • Outbox : displays mails in folder “Outbox”.
  • Selected Folder: displays mails in given folder.
  • Trash Folder: displays mails in folder “Trash”. i.e. Deleted mails.

 

Screen Snapshot: EM Mail – List (Outbox)

 

EM Mail List Screen has following information fields and menu options.

 

 

All Mails have following Menu Options:

 

 

Mail Id

Mail Id number.

 

View

View mail details.

 

Send

Send mail screen.

 

Move

Move mail screen.

 

Delete

Delete mail confirmation screen.

 

DeleteFiles

Delete mail files confirmation screen.

 

 

 

 

Type/Status

Mail type [IN/OUT]. Status: [Blank/Deleted/Send]

 

Date

Date Mail created.

 

Folder

Folder name.

 

Sender

Sender Info. i.e. [Mail Id].[User Id]@[Site Id]

 

From

From Info.

 

To

To Info.

 

Subject

Subject Line.

 

 

 

 

EM MAIL type has following additional Menu Options:

 

 

Import

Import mail screen.

 

View Imported

View Imported mail screen.

 

Imported Options:

Note: Applicable when Mail is imported.

 

CleanUp

Delete (and completely clean-up) the imported mail.

 

Move to Inbox As:

 

 

Copy

Copy Imported Mail Objects with new Object Ids to EM Inbox.

 

Refresh

Refresh Imported Mail Objects (which don’t already exist) keeping same Object Ids to EM Inbox.

 

RefreshUpdate

Refresh as above, plus:

If object already exist and the imported Object is newer than existing, information will be updated.

 

Create Collaboration

Create Collaboration from EM MAIL screen.

 

 

 

 

 

 

 

Folders

 

Use this screen to view EM Mail folders list.

 

Screen Snapshot: EM Mail - Folders

 

Folders Screen has following information fields and menu options.

 

 

Folder

Folder name.

 

Mails

Number of mails in the folder.

 

List Options:

 

 

List All

List all the mails in the folder.

 

Mail Type:

 

 

In

List mails in the folder with mail type = IN.

 

Out

List mails in the folder with mail type = OUT.

 

 

 

 

Delete Folder

Delete all the mails in the folder, i.e. move to Folder “Trash”.

 

Empty Trash

Permanently remove/delete all the mails (including mail files) in the folder Trash.

Note: Only applies to Trash folder. Imported mails are not removed.

 

 

 

Imported Mail

 

Use this screen to view imported EM Mails which can be present in any folder.

 

Screen Snapshot: EM Mail - Imported Mail List

Imported Mail Screen has following information fields and menu options.

 

 

Imported Id

Imported Mail Id i.e. “EMMAIL” + Mail Id.

 

Mail Id

Mail Id number.

 

Date Imported

Date Mail imported.

 

Import

Import mail screen.

 

View Imported

View Imported mail screen.

 

Imported Options:

Note: Applicable when Mail is imported.

 

CleanUp

Delete (and completely clean-up) the imported mail.

 

Move to Inbox As:

 

 

Copy

Copy Imported Mail Objects with new Object Ids to EM Inbox.

 

Refresh

Refresh Imported Mail Objects (which don’t already exist) keeping same Object Ids to EM Inbox.

 

RefreshUpdate

Refresh as above, plus:

If object already exist and the imported Object is newer than existing, information will be updated.

 

 

Note on Restrictions:

 

Data Records selection: Only data records of EM Table [DEF] with No or partial links to database are selected. Linked table data from actual database tables is not handled.

 

Data Type Exclusions: While copying or refreshing data records of a EM Table [DEF], the field type FILE’s data are not handled if the destination for FILE data is disk (and not database).

 

 

 

 

EM Mail Selected (Generic View)

 

EM Mail uses this generic screen to view selected EM Mail record and present any additional/specific options as per the action selected.

 

Following EM Mail List mail record actions use EM Mail Selected view, any additional/specific information or options are detailed separately:

  • View
  • Send
  • Move
  • Delete
  • DeleteFiles
  • Import
  • View Imported
  • CleanUp
  • Refresh
  • RefreshUpdate

 

 

Screen Snapshot: EM Mail - Selected (View)

 

EM Mail Selected (Generic View) Screen has following information fields and menu options.

 

 

Mail Id

Mail Id number.

 

Type/Status

Mail type [IN/OUT]. Status: [Blank/Deleted/Send]

 

Date

Date Mail created.

 

Folder

Folder name.

 

Sender

Sender Info. i.e. [Mail Id].[User Id]@[Site Id]

 

From

From Info.

 

To

To Info.

 

Subject

Subject Line.

 

Mail Files Info

Lists the mail files and their size in bytes or message “File does not exist or Can not Read”. The files listed are

[Mail Id]_P0.EMM

[Mail Id]_P1.EMM

[Mail Id]_P1_DAT.EMM (if present)

If the file is present, then Download link is displayed with it.

 

Download

Download the particular mail file from application server for viewing or saving locally on client.

 

 

 

EM Mail - View

 

Use this screen to view details of a selected single EM Mail.

 

 

Screen Snapshot: EM Mail - View

 

EM Mail View Screen uses EM mail Selected (Generic View) and additional/specific information or options as given below.

 

 

EM mail Selected (Generic View) Info:

Described separately before.

 

Additional Info:

 

 

Upload

Upload a mail file manually from client to application server. Lists upload links for:

[Mail Id]_P0.EMM

[Mail Id]_P1.EMM

[Mail Id]_P1_DAT.EMM (optional)

 

 

 

EM Mail - Send

 

Use this screen to Send selected EM Mail to Mail Servers.

 

NOTE: Following MUST be set before using Mail Send:

  • The SMTP mail server parameters in em_param configuration file
    • em.param.em_mail_out: Outgoing Mail server protocol, host, port (blank=default) for use by EM Mail
  • The User Mail (POP3/SMTP) account details (userid, password, folder, suffix, etc) on “Options: Update Registration Data” screen.

 

 

Screen Snapshot: EM Mail - Send

 

EM Mail Send Screen has following information fields and menu options.

 

 

Is EM Mail Type

Yes: If it is EM Mail Type

 

Mail Id

Mail Id number.

 

Priority

Mail Priority

 

Size

Mail size

 

Date

Date Mail created.

 

Folder

Folder name.

 

Type/Status

Mail type [IN/OUT]. Status: [Blank/Deleted/Send]

 

Sender

Sender Info. i.e. [Mail Id].[User Id]@[Site Id]

 

From

From Info.

 

To

To Info.

 

Subject

Subject Line.

 

Sent Date

Date Mail sent.

 

Received Date

Date Mail received.

 

Headers

Mail Headers.

 

Keywords

Keywords.

 

Mail Files Info

Lists the mail files and their size in bytes or message “File does not exist or Can not Read”. The files listed are

[Mail Id]_P0.EMM

[Mail Id]_P1.EMM

[Mail Id]_P1_DAT.EMM (if present)

If the file is present, then Download link is displayed with it.

 

Parameters to override for Send operation

 

 

From

Edit From Info.

 

To

Edit To Info.

 

Subject

Edit Subject Line.

 

 

 

 

 

 

EM Mail - Move

 

Use this screen to move selected EM Mail to a particular folder.

 

This screen allows you to select a pre-existing folder or create/assign a new folder. Use “Folders” menu option to view folder list.

 

Screen Snapshot: EM Mail - Move

 

EM Mail - Move Screen uses EM mail Selected (Generic View) and additional/specific information or options as given below.

 

 

EM mail Selected (Generic View) Info:

Described separately before.

 

Additional Info:

 

 

Move To

Select one from Drop-down of existing Folder names.

 

Or Create New Folder

Folder name for new folder to be created. If specified (i.e. not blank) then drop-down selection above is ignored.

 

 

 

EM Mail – Delete

 

Use this screen to delete selected EM Mail i.e. move it to “Trash” folder. Confirmation screen is displayed.

 

Screen Snapshot: EM Mail - Delete

 

EM Mail - Delete Confirm ? Screen uses EM mail Selected (Generic View) and additional/specific information or options as given below.

 

 

EM mail Selected (Generic View) Info:

Described separately before.

 

Additional Info:

 

 

Message:

Mail Delete will move the Mail to Trash Folder.

 

 

 

EM Mail – DeleteFiles

 

Use this screen to delete mail files only (if present) of selected EM Mail from disk. Confirmation screen is displayed.

 

Screen Snapshot: EM Mail – Delete Files

 

EM Mail – Delete Files Confirm ? Screen uses EM mail Selected (Generic View) and additional/specific information or options as given below.

 

 

EM mail Selected (Generic View) Info:

Described separately before.

 

Additional Info:

 

 

Message:

Note: Delete Files will only remove the Mail Files from Disk completely.

 

 

 

EM Mail – Import

 

Use this screen to import selected EM Mail i.e. create Mail EM Inbox: EMMAIL[Mail Id], and import all the EM Objects and table data into this User Id.

 

Screen Snapshot: EM Mail - Import

 

EM Mail – Import Screen uses EM mail Selected (Generic View) and additional/specific information or options as given below.

 

 

EM mail Selected (Generic View) Info:

Described separately before.

 

Import data for FILE type?

One of: Yes, No

 

Option “Yes” is available if the following configuration parameter allows for it:

em.param.em_app_mail : DisableFILE_MailImp

 

Additional Info:

 

 

Message:

Note: Import Mail will create objects into your EM Inbox from Files.

 

 

 

 

EM Mail - View Imported

 

Use this screen to sign-out from your Inbox and sign-in to imported mail Inbox i.e. sign-in as User: EMMAIL[Mail Id].

 

Use [Exit Mail] link afterwards to return to your EM Inbox.

 

Screen Snapshot: EM Mail – View Imported

 

EM Mail – View Imported Screen uses EM mail Selected (Generic View) and additional/specific information or options as given below.

 

 

EM mail Selected (Generic View) Info:

Described separately before.

 

Additional Info:

 

 

Message: (When mail is imported.)

Mail Import Info - Imported As: EMMAIL[Mail Id], On: [Mon dd yyyy hh:mm:ss: AM/PM].

Submit will open a new Window with Imported Mail Sign-In.

 

Message: (When mail is not imported yet.)

Mail Imported Not Found! Please use Import first.

 

 

NOTE:

  • When signed-in into EMMAIL[Mail Id] Inbox, if you see no folders under Explorer then use one of following ways/links to view any objects not marked from root tree and are hanging loose:
  • Inbox -> POWER Search -> (List) All Of These
  • Inbox -> POWER Search -> (List) Text or Folders  OR Tables OR WebProjects

 

 

EM Mail – CleanUp

 

Use this option to completely clean-up i.e. remove imported mail Inbox i.e. User: EMMAIL[Mail Id] from database.

 

Once Cleaned-Up, the action is not reversible and mail wil be needed to import again from mail files.

 

Screen Snapshot: EM Mail - CleanUp

 

EM Mail – CleanUp Screen uses EM mail Selected (Generic View) and additional/specific information or options as given below.

 

 

EM mail Selected (Generic View) Info:

Described separately before.

 

Additional Info:

 

 

Message: (When mail is imported.)

Mail Import Info - Imported As: EMMAIL[Mail Id], On: [Mon dd yyyy hh:mm:ss: AM/PM].

Submit will completely Clean-Up Imported Mail.

 

Message: (When mail is not imported yet.)

Mail Imported Not Found! Please use Import first.

 

 

EM Mail – Copy

 

Use this screen to copy EM Objects from imported mail to your own Inbox with new object Ids.

 

This will copy Imported Mail Objects with new Object Ids to your EM Inbox.

 

Screen Snapshot: EM Mail - Copy

 

EM Mail – Copy Screen uses EM mail Selected (Generic View) and additional/specific information or options as given below.

 

 

EM mail Selected (Generic View) Info:

Described separately before.

 

Additional Info:

 

 

Message: (When mail is imported.)

Mail Import Info - Imported As: EMMAIL[Mail Id], On: [Mon dd yyyy hh:mm:ss: AM/PM].

 

Submit will copy Imported Mail Objects with new Object Ids to your EM Inbox. 

 

Message: (When mail is not imported yet.)

Mail Imported Not Found! Please use Import first.

 

 

EM Mail Copy Limitations:

  • At present following limitations apply. Efforts are on to upgrade them in future releases.
  • WebProject Object Send/Receive parameters: Send and receive parameters properties will show old field ids i.e. they are not updated to reflect new field ids.

 

EM Mail – Refresh

 

Use this screen to copy EM Objects from imported mail to your own Inbox.

 

This will Refresh i.e. copy Imported Mail Objects (which don’t already exist) keeping same Object Ids to your EM Inbox.

 

Screen Snapshot: EM Mail - Refresh

 

EM Mail – Refresh Screen uses EM mail Selected (Generic View) and additional/specific information or options as given below.

 

 

EM mail Selected (Generic View) Info:

Described separately before.

 

Additional Info:

 

 

Message: (When mail is imported.)

Mail Import Info - Imported As: EMMAIL[Mail Id], On: [Mon dd yyyy hh:mm:ss: AM/PM].

 

Submit will refresh Imported Mail Objects keeping same Object Ids to your EM Inbox.
If Object Id already exists, it is not refreshed.

 

Message: (When mail is not imported yet.)

Mail Imported Not Found! Please use Import first.

 

 

 

EM Mail – RefreshUpdate

 

Use this screen to copy/update EM Objects from imported mail to your own Inbox.

 

This will Refresh as above, plus:

If object already exist and the imported Object is newer than existing, information will be updated.

 

Screen Snapshot: EM Mail – RefreshUpdate

 

EM Mail – RefreshUpdate Screen uses EM mail Selected (Generic View) and additional/specific information or options as given below.

 

 

EM mail Selected (Generic View) Info:

Described separately before.

 

Additional Info:

 

 

Message: (When mail is imported.)

Mail Import Info - Imported As: EMMAIL[Mail Id], On: [Mon dd yyyy hh:mm:ss: AM/PM].

 

Submit will refresh Imported Mail Objects keeping same Object Ids to your EM Inbox.
If the imported Object is newer than existing, information will be updated.  

 

Message: (When mail is not imported yet.)

Mail Imported Not Found! Please use Import first.

 

 

EM Mail - Create Collaboration

 

Use this screen to create collaboration EM Inbox from selected EM Mail i.e. create EMAPP EM Inbox: EMAPP[Mail Id], and import all the EM Objects and table data into this User Id.

 

Screen Snapshot:

 

EM Mail – Create Collaboration Screen uses EM mail Selected (Generic View) and additional/specific information or options as given below.

 

 

EM mail Selected (Generic View) Info:

Described separately before.

 

Additional Info:

 

 

Message:

Note: Create Collaboration will create a special EM Inbox: EMAPP[Mail Id], into which objects from Files will be imported.  

 

 

 

Check Mail

 

Use this screen to check on new email received for your account from a mail POP Server. The received / downloaded email can be received as normal email or special EM Mail. 

 

NOTE: Following MUST be set before using Check Mail:

  • The POP3 mail server parameters in em_param configuration file
    • em.param.em_mail_in: Incoming Mail server protocol, host, port (blank=default) for use by EM Mail
  • The User Mail (POP3/SMTP) account details (userid, password, folder, suffix, etc) on “Options: Update Registration Data” screen.

 

 

Screen Snapshot:

 

EM Mail – Check Mail Screen has following information fields and menu options.

 

 

Info

Retrieved 6 messages from Folder [INBOX].

 

 

 

 

Action (Dropdown)

Select one of:

Mark Read: To Mark so in Mail Server

Mark Deleted: To Mark so in Mail Server

Receive : To Receive / Download selected mail from mail server into EM Mail Box with options selected.

 

Mails retrieved info

 

 

Srl

Mail List Serial No

 

Msg No

Message Number from Mail Server.

 

Priority

Mail Priority

 

From

From Info.

 

To

To Info.

 

Received

Date Mail received.

 

Size

Mail size

 

Sent

Date Mail sent.

 

 

 

 

CheckBox: Mail Select

To Select Mail

 

CheckBox: In Db As TEXT?

Not used, For future use.

 

View

Lists the single message selected with same info as of this screen.

 

Subject

Subject Line.

 

Mail Details

Headers:

Flags:

 

 

Mail Parts

Part No

ContentType

Disposition

Is Attachment / File Name

Size

 

 

CheckBox: Is EM Mail Type

If mail is EM Mail Type having 3 parts to package application parts.

 

 

 

Search Mail

 

Use this screen to search for Mails (i.e. Received and stored emails).

 

Simple Search Form allows query on “Mail Subject” or Display All.

 

Advanced Search Form allows query on Mail Related Parts:

  • From
  • To
  • Headers
  • Priority
  • Folder Names
  • Mail Id
  • Mail Type

 “Mail Subject” or Display All.

And dates criteria.

 

 

Chapter 2: Using Collaboration

 

Please note that collaboration allows access, by other users, to your application Objects also in addition to data. It also provides Inbox-to-Inbox objects-&-data refresh and copy functions.

 

 

Creating A Collaboration

 

There are two ways:

 

  1. An existing EM Inbox can set property of Collaboration.
  2. A New EM Inbox can be created for the purpose of collaboration from an existing EM Mail record or an Imported Mail record. Please refer to “Mail Box: List Mail : Create Collaboration” and “Mail Box: Imported Mail: Create Collaboration” screens for details.

 

In both cases, after EM Inbox is created, Select View or Sign-In to it, and create Application Registration of type Collaboration.

 

 

Collaboration Application Registration

 

Use the Application Registration screen to define collaboration. There are different types of collaboration access or methodology available.

 

Collaboration Group: Defines collaboration access registration where the users (subscribers) get full access to Owner’s EM Inbox objects and they also can perform search and data tasks. Allows for Inbox-to-Inbox level object transfer functions. Please note that Read/Add/Change/Delete/Archive Security Permissions have special meaning for collaboration, they indicate Inbox-to-Inbox level object transfer capabilities. Please refer to Collaboration chapter. Registered or public users can be this group’s subscribers.

 

For Inbox-to-Inbox level object transfer:

·        “Collaboration” and “CollabAppAuthUsr”: Used for defining collaboration access registration for use by a group of registered users. With “Collaboration” type access available only after creating subscription record. But with “CollabAppAuthUsr” type access available without need for creating subscription record. This category allows for Inbox-to-Inbox objects-data transfer functions. You can not sign-in to collaboration app but only can copy it, modify, then refresh original.

 

 

For Full access to Owner’s EM Inbox:

·        NOTE: PLEASE USE FOLLOWING WITH CAUTION AS YOU ARE GRANTING FULL ACCESS TO YOUR INBOX TO OTHERS

·        CollabSharedAuthUsr: Used for defining collaboration access registration for use by registered users only but without the need for creating subscription record. This category does not allow for Inbox-to-Inbox objects-data transfer functions but you can sign-in to collaboration app and have full access.

·        CollabSharedPublic: Defines collaboration access registration where non-registered users get full access to Owner’s EM Inbox objects and data. This is way of defining Superuser or Assume Identity type of access for public. This category does not allow for Inbox-to-Inbox objects-data transfer functions but you can sign-in to collaboration app and have full access.

 

 

Creating MyCopy Of A Collaboration

 

The subscribed collaboration menu allows you to create a MyCopy i.e. complete copy of Collaboration Owner’s EM Inbox (excluding his user info, application reg/sub records) for your own use.

 

Please refer to sections below for further information.

 

 

Collaboration Menu

 

Collaboration Menu has following options:

 

Create CollaborationBox 

  • Create New SubInbox: Create New Blank CollaborationBox of type SubInbox 

   

List CollaborationBoxes 

  • List All Types: List CollaborationBoxes of all types 
  • List SubInboxes (Avatars): List CollaborationBoxes of type SubInbox (Avatar) 
  • List MyCopy: List CollaborationBoxes of type MyCopy  
  • List ImpMails: List CollaborationBoxes of type ImportedMails Collab 

 

List Subscribed/Authorized Collabs 

  • List Subscribed/Authorized: List Subscribed/Authorized Collaborations

 

List CollaborationBoxes 

Lists collaborations owned by you and MyCopy i.e. copies made by you of other collaborations for your own use.

 

Subscribed:

Lists collaborations of type “Collaboration” that are subscribed by you.

 

Authorized:

Lists collaborations of type “CollabAppAuthUsr”, “CollabAppSpecUsr” that are authorized for your use.

 

 

Search My Collabs:

Displays Search form and then lists matching collaborations of type My Collabs.

 

Search Sub/Auth:

(Feature not available in this build.)

 

Search Shared SpecUsr:

Displays Search form and then lists matching collaborations of type  “CollabSharedSpecUsr” that are available.

 

Search Shared Auth/Public:

Displays Search form and then lists matching collaborations of type “CollabSharedAuthUsr”, “CollabSharedPublic” that are available.

 

 

 

Creating New SubInbox type of Collaboration

 

The collaboration menu allows you to create a New Blank SubInbox type of Collaboration for your own use. Use it for creating your different Avatars or virtual Inboxes for any need.

 

 

List My Collabs

 

This screen has following information and options:

 

This screen lists all the owned (i.e. created from Mail) and MyCopy (i.e. created from subscribed) collaboration records. List displays:

Id

Collaboration Id

Own / Link Id: Either Owner User Id or linked/other User Id.

Date Created

Name

 

Options:

View : Select/Sign-In to selected collaboration.

Clean-Up: Completely remove selected Owned or MyCopy collaboration EM Inbox.

 

 

List Subscribed/Authorized

 

Subscribed/Authorized Collaborations screen has following information and options:

 

This screen lists all the application subscription records of type “Collaboration” and “CollabAppAuthUsr”. List displays:

Type

Collaboration Id

Name / Role

Collaboration Application Registration Info: Data Grp, Access Id, Access String

 

Options:

Select Collaboration Link: Selects one collaboration from list and displays details.

 

 

Subscribed/Authorized Collaboration Selected

 

Subscribed/Authorized Collaboration Selected screen has following information and options:

 

This screen lists one selected record. Screen displays:

Type

Collaboration Id

Name / Role

[Info]: Collaboration Application Registration Info: Data Grp, Access Id, Access String

 

Your Inbox linked (associated) with this collaboration:

My Inbox Id

Name

 

And a list (if any) of MyCopy or owned collaborations created or linked (associated) with this:

MyCopy Id

Name

 

Options:

Create-New-MyCopy: Creates a new MyCopy of this collaboration.

Link-To-MyCopy: Displays a list of existing owned or MyCopy collaborations to choose one.

 

Inbox-to-Inbox Objects-Data transfer options:

From Collaboration ====> To MyCopy

Refresh

RefreshUpdate

Copy

 

To Collaboration <==== From MyCopy

Refresh

RefreshUpdate

Copy

CleanUpMaster-Refresh : This action DELETES the Collaboration EM Inbox (i.e. completely remove all objects-data excluding user info, app reg/sub info), and refreshes from MyCopy EM Inbox.

 

Where the transfer options have following effect (Object means objects and data too):

 

 

Inbox-to-Inbox:

 

 

Copy

Copy source Objects with new Object Ids to target EM Inbox.

 

Refresh

Refresh source Objects (which don’t already exist) keeping same Object Ids to target EM Inbox.

 

RefreshUpdate

Refresh as above, plus:

If source object already exist and is newer than target (existing), information will be updated.

 

 

Note on Restrictions:

 

Data Records selection: Only data records of EM Table [DEF] with No or partial links to database are selected. Linked table data from actual database tables is not handled.

 

Data Type Exclusions: While copying or refreshing data records of a EM Table [DEF], the field type FILE’s data are not handled if the destination for FILE data is disk (and not database).

 

 

 

 

Chapter 3: Collaboration Search

 

This chapter describes the search functions for collaboration.

 

 

Search Shared Spec User

 

Use this screen to search for collaborations of type “CollabSharedSpecUsr” that are available to you. Please refer to Collaboration Search screen below for details.

 

 

Search Shared Auth/Public

 

Use this screen to search for collaborations of type “CollabSharedAuthUsr” and “CollabSharedPublic” that are available to you. Please refer to Collaboration Search screen below for details.

 

 

 

Collaboration Search

 

Use this screen to search for collaborations of type “CollabSharedPublic” that are available to you.

 

The Collaboration Search Form is similar to Content Search Form. Once you select a collaboration from the displayed list, full access is allowed to it just as you access EM Inbox.

 

 

Chapter 4: Virtual Wave : EMit (Status Updates), Tagging & TagPlus

 

This chapter describes the functionality about Virtual Wave and details out features available for EMitting, data record Tagging and TagPlus, which enhances user collaboration and analytics of information.

 

 

EMit : Status Updates

 

 

EMit

  • EMit Allows for status updates from user. EMitting is to submit status updates. Latest status updates and EMits are available to other users as per their security settings.

 

 

Tagging & TagPlus

 

 

Tagging & TagPlus

Data record tagging allows adding Data Tags to any exact places on Form where needed. Thus information is available in applications on screens and not lost in emails.

 

The configuration parameters allow for enabling or disabling this feature at individual application or global level.

 

Tag Menu will be available during App Run: on WebScreen Run (Execute) for Display type of Form or thru POWER SearchŕSearch WebProject ScreensŕResults screen.

 

 

How does Tagging work

 

 

How does it work:

 

Taggers

There are following classifications of persons for Tagging (in the descending order of weight-age):

  • GTM: Group Tagger - Mandatory
  • GTO: Group Tagger – Optional
  • EUT: End User Tagger

 

Application Owners will define who are each category persons for their application. Also a rating or weight-age can be given for each person to define his authority level in hierarchy (at present this is the serial position in the list, i.e. those at the beginning of list have more weight-age than their followers, in each category.

 

While adding Tag the Tagger can define the viewing scope for Tag (“For Viewing By”) which will be applied at the time of Tag Viewing by others:

  • For Viewing By: (in order of levels)

·        GTM: Group - Mandatory

·        GTO: Group - Optional

·        EUP: EndUser Public (AnyOne)

·        EUS: EndUser & My Subscribers

·        EUT: EndUser - MySelf Only

 

Tagger Categories:

 

GTM: Group Tagger - Mandatory

This category can add tags for GTM and EUS/EUT levels. The tags added as GTM can not be turned off while display.

 

GTO: Group Tagger - Optional

This category can add tags for GTO and EUS/EUT levels. The tags added as GTO can be turned off while display.

 

EUT: End User Tagger

This category can add tags for EUS and EUT levels. The tags added as EUS can be viewed by other subscribers allowed by EUT Tagger. And EUT level tags are for personal viewing only.

 

NOTE: While creating the tag, “For Viewing By” can be set to any level by any category of Tagger, But the enforcement as per Tagger’s priviledge is applied while display of tag only.

 

Viewable Option meanings:

EUP: EndUser Public (AnyOne)

This options makes your tag viewable by AnyOne / Public. Also available via WP Exec DAU.

 

EUS: EndUser & My Subscribers

This options makes your tag viewable by your Subscribers as granted on TagPlus screens.

 

 

Adding Simple Tag

To add a Simple Tag, Use Tag Menu for “Create New Tag”. Select drop-down Simple Tag. Once Tag is created set TagPlus properties and you are done. The Simple Tag will be seen in the application run by any user.

 

Adding Advanced Tag

To add a Data Tag, a receptacle object (TGV table) needs to be created using Create Tagging Base and defining the fields on newly created table by switching to user’s own Inbox. Then Tag Menu allows for defining the table level properties and mapping fields. “Create New Tag”  allows for creating blank record in TGV table. Once the data is edited there (again by switching to user’s own Inbox), the Data Tag will be seen in the application run by any user.

 

Defining Taggers

Application Owners will define which users have GTM, GTO or EUT roles.

GTM: They can set a specific user list (token “ALL” not honored.)

GTO: They can set a specific user list (token “ALL” not honored.)

EUT: They can set a specific user list or token “ALL” to indicate all users have EUT role.

 

Tag Viewers

Application Owners will define who can view Tags. They can set a specific user list or token “ALL” to indicate all users can view tags.

(It is possible that Tag Adder do not have Tag Viewing permissions, so that they can only add/edit Tags but not able to view them (via WP Form) while display.)

  • TagViewers can be set for following categories:

·        GTM: Group - Mandatory

·        GTO: Group - Optional

·        EUS: EndUser & My Subscribers

·        EUT: EndUser - MySelf Only

Note:

  • Application Owners can set, for each category, a specific user list or token “ALL” to indicate all users for that category.
  • EUP - Public tags are viewable by any user as per definition.

 

Displaying Data Tag

The data record will display Tags as applicable provided the app user has Tag Viewer privilege.

 

Session Settings

Session level settings allow for turning On or Off of Tag displays. Please refer to Session settings section below.

 

 

Virtual Wave

 

Define a unique “Virtual Wave Id” and use it for multiple tag additions. Other Taggers can use the same Virtual Wave Id for adding tags. In effect, this forms a virtual wave linked by same “Virtual Wave Id” for all viewers.

 

 

Some Requirements and Configuration Parameters

 

Some Requirements

For Tagging following requirements should be met:

 

  • EMit status updates are available in Inbox.
  • Tags are added and viewed in AppRun mode.
  • EUP Tags (and GTM Tags) are available in WP Exec Direct Access URL Mode.
  • For Adding Advanced Tags by app users to previously created records, app users must have Inbox Owner privileges i.e.:
    • [developer] User Id : Yes
    • OR
    • [selfapp] User Id : Yes
    • AND
    • [apponly] User Id : No
  • To display added data tags, At present, The WebProject Screen Table Form Layout orientation must be “Normal”. (So it is good idea to add tags to those forms which are “Normal” orientation.

 

 

Configuration Parameters

For Tagging following parameters should be set in em_param configuration file:

em.param.em_tg_<ALL|AppId>

em.param.em_tg_tagp_<ALL|AppId>

em.param.em_tg_ext_<ALL|AppId>

 

Configurable Options via Parameters

For Tagging following options are configurable via above parameters set in em_param configuration file:

 

Tagging Users Lists:

  • Group Tagging Users - Mandatory
  • Group Tagging Users - Optional
  • EndUser Tagging Users
    • Can be defined as “ALL” meaning all users can add tags.

 

 

TagViewer User Lists:

  • Viewers For GTM
  • Viewers For GTO
  • Viewers For EUS
  • Viewers For EUT

 

(Each list above Can be defined as “ALL” meaning all users can view tags for that category.)

 

 

Some settings:

 

Enforce Effective Dates:

  • One Of:
  • Effective From
  • Valid Thru
  • Both - Effective From & Valid Thru

 

Allow:

  • UnTag
  • RemoveTag
  • ReTag

 

EndUser Public Tagging Allowed:  Yes/No

 

Display GTM Tags in WP Exec DAU Mode: Yes/No

 

Simple Tagging By Users with No Inbox, Allowed:  Yes/No

 

MaxSizes:

  • Tag text (One Field Val) display size
  • Title of Tag text (One Field Val) display size
  • Max No Of Tags Per Record displayed
    • Please set some tag groups Off (e.g. GTO, EUS, EUP) if you are hitting upper limits and your tags are not displayed.

 

 

Defining Groups of Subscribers (EUS) or ToFollow (TFL) Users:

 

Please use Inbox Menu : Applications : Auth Roles/Grants.

 

Subscriber (EUS) Lists:

  • Please create Auth Roles with Auth Type: “TAGEUS”.
  • You can define list nested up to 2 levels.

 

For Example:

  • Create Auth Type: TAGEUS,  Auth Name: TagEUSUserList1
    • Grant : Create Grant To User Id: TagEUSUserListDet1
  • Create Auth Type: TAGEUS,  Auth Name: TagEUSUserListDet1
    • Grant : Create Grant To User Id: Consumer1
    • Grant : Create Grant To User Id: Consumer2
  • Now you can Grant to Role “TagEUSUserList1” and this provides Specific User access to Consumer1 & Consumer2

 

 

ToFollow (TFL) Lists:

  • Please create Auth Roles with Auth Type: “TAGTFL”. The UserIds granted to this Role are your ToFollow Lists.

 

 

 

Tag Menu

 

The menu options for Tag Menu are:

 

Tagging Menu (Simple) :

  • Tagged Data Management of Simple Tags

 

Tagging Menu (Advanced) :

  • Create Tagging Base: Create equivalent Category for TGV Table
  • Tagging Configuration
    • Table Level Options
    • Field Mapping and Options
  • Tagged Data Management Of Advanced Tags
  • Remove Tagging Base: Will remove Only Table/Field mapping definitions. The actual table in your Inbox (and data) is not removed.

 

 

Tagged Data Management allows for

    • Query Tagged Record Info OR Query and Update Multiple Records
      • ChangeTag (Edit Individual Record Tag Info).
        • UpdateDatesOption (Set Effective From, Valid Thru or Both dates.)
        • UnTag
        • ReTag
        • RemoveTag
      • View/Edit TagPlus

 

Create A New Tag

    • For more info Please refer to “Create A New Tag” section below.

 

 

 

Create A New Tag

 

Following information and options are displayed on this sub-screen:

 

 

 

 

 

Simple or Advanced ?

One of :

  • Simple (No Tagging Base Req)
  • Advanced (With Tagging Base)

 

EMit – Status Update?

One of : Blank or “Yes”

 

For Record #

Record #

 

For WebProject #

WebProject #

 

For Viewing By

One of:

  • For Viewing By: (in order of levels)

·        GTM: Group - Mandatory

·        GTO: Group - Optional

·        EUP: EndUser Public (AnyOne)

·        EUS: EndUser & My Subscribers

·        EUT: EndUser - MySelf Only

 

 

Virtual Wave ID

Optionally assign a Virtual Wave ID string to this tag.

 

Grant EUS Subscriber Viewing Access TO:

Allows for 5 values of any of following types:

  • Granted User’s ID
  • OR Granted Role (Auth Name) Level 1
  • OR Granted Role (Auth Name) Level 2

Note:

  • Use Defined Roles using Auth Roles
  • The Auth Type of Roles must be “TAGEUS”
  • Roles beyond level 2 not supported

 

Please refer to “Defining Groups of Subscribers (EUS) or ToFollow (TFL) Users” above.

 

Create

Form Submit Button

 

 

 

View/Edit TagPlus

 

Following information and options are displayed on this screen:

 

 

 

 

 

 

One (1) Field Id:

Optional.

 

One (1) Field Value:

Comment or Info string.

 

EMit – Status Update?

One of : Blank or “Yes”

 

For Record #

Record #

 

For WebProject #

WebProject #

 

For Viewing By

One of:

  • For Viewing By: (in order of levels)

·        GTM: Group - Mandatory

·        GTO: Group - Optional

·        EUP: EndUser Public (AnyOne)

·        EUS: EndUser & My Subscribers

·        EUT: EndUser - MySelf Only

 

 

Virtual Wave ID

Optionally assign a Virtual Wave ID string to this tag.

 

Grant EUS Subscriber Viewing Access TO:

Please refer to “Grant EUS Subscriber Viewing Access TO:” Under Create A New Tag.

 

TagPlus Properties

 

 

 

 

 

TagPlus Tags

Assign upto 15 tag tokens to this tag record.

e.g. Shopping, Technology, Green, etc.

 

 

 

 

TagPlus Data Capture

A custom screen as per defined by Application Owner is displayed and many, many options can be set.

e.g. Action: Accepted, In process, …

Vote For record: Yes, No

 

Submit

Form Submit Button

 

 

 

 

 

 

 

Tagging Configuration

 

 

Following information is displayed:

[Tagged TO Id: T# 100004 (TGV Table Id: T# 100044)]

 

Table Level Options

  • Following properties can be set:
  • Each property can checked / enabled if you have authorization as indicated by “Allowed” = Yes.

 

 

Property

Meaning

 

Form - Override Cosmetic      

Override Form Properties Cosmetic (except orientation)

 

** Form - Filler 1

Not Implemented

 

Form - Hide Original HTML FreeStyle     

Hides HTML FreeStyle properties of original record.

 

Form - Treat all above settings as Final - Restrict Others in chain

Makes your setting final. Will stop looking for any settings by other followers in chain. (Please note any settings by previous higher weight-age Taggers will still apply.)

 

Form - Add HTML FreeStyle    

Add HTML FreeStyle properties from Tagged record.

 

Form - Restrict Add HTML FreeStyle by Others in chain      

Will stop looking for “Form - Add HTML FreeStyle” settings by other followers in chain.

 

** Data - Allow Tags Effective By / Expiry Dt     

Not Implemented

 

Data – Add TagPlus Data     

Display TagPlus Data added

 

Data - Restrict Adding TagPlus Data by Others in chain      

Restrict Display TagPlus Data added by others in chain.

 

** Not Implemented

 

NOTE: When the Query Form has NO original records Found, ONLY Following, if set, has effect. Rest of Table Level Options are not in effect.

 

 

Property

 

 

Form - Hide Original HTML FreeStyle     

 

 

 

Table TagPlus Options

  • The TagPlus properties are displayed. The Form need not be filled in this place.

 

Field Mapping and Options

  • The field mapping for tagging are configured here. Also set properties for the mapped fields.
  • Un-mapped fields on right are ignored.

 

This Screen has following information fields and menu options.

 

 

 

 

 

Srl

Srl No

 

Pos

Position Srl for each field: 1,2,3

 

Field Name [Datatype:Length:Disp Len]

Original Field details

 

Tag Position

Placing of Tagged record field position.

One of: Before, On, After

(of Original field)

 

Field Name [Datatype:Length:Disp Len]

Tagged Field details

Select field from drop-down.

Blank = Ignore this Srl/Pos item.

 

  • For each mapping above, Following properties can be set:
  • Each property can checked / enabled if you have authorization as indicated by “Allowed” = Yes.

 

Mapping Properties:

 

Property

Meaning

 

Field - Override Positioning - Lines Bef   

 

 

** Field Prompt - Filler 1   

 

 

Field Prompt - Override Column TD Prop   

 

 

Field Prompt - Override Field Name and Cosmetic   

 

 

Field Prompt - Hide Original - FreeStyle HTML   

 

 

Field Prompt - Hide Original Prompt All   

 

 

Field Prompt - Treat all above settings as Final - Restrict Others in chain   

 

 

Field Prompt - Add FreeStyle HTML   

 

 

Field Prompt - Restrict FreeStyle HTML Additions by Others in chain   

 

 

Field Prompt - Add New Prompt All    

 

 

Field Prompt - Restrict Addition New Prompt by Others in chain   

 

 

Field Prompt - Apply Even-If Current Record Queried Not Tagged   

 

 

Field Data - Override Cosmetic   

 

 

Field Data - Override Column TD Prop   

 

 

Field Data - Override Field Data Value   

 

 

Field Data - Hide Original - FreeStyle HTML   

 

 

Field Data - Hide Original Data All   

 

 

Field Data - Treat all above settings as Final - Restrict Others in chain   

 

 

Field Data - Add FreeStyle HTML   

 

 

Field Data - Restrict FreeStyle HTML Additions by Others in chain   

 

 

Field Data - Add Data    

 

 

Field Data - Restrict Addition Data by Others in chain   

 

 

Field Data – Apply Even-If Current Record Queried Not Tagged

 

 

** Not Implemented

 

 

 

Session Settings

 

The session settings in App Run mode can be viewed and set via Options->Tagging.

 

  • Information about Tagging Settings and Users and options in effect is available.

 

Tagging Settings:

 

Following are available options:

1  Display Group Tagging - Mandatory  [Always On]

2  Display Group Tagging - Optional    [On/Off]

3  Display EndUser Subscribed Tagging    [On/Off]

4  Display EndUser Tagging    [On/Off]

5  Display EndUser Public Tagging    [On/Off]

6  Restrict Display EUS and EUP to ToFollow (TFL) List    [On/Off]

 

 

This screen displays following information e.g.:

 

Tagging Users Information:

 

Group Tagging Users - Mandatory:

  CONSUMER  John

 

Group Tagging Users - Optional:

  John01  Student

 

EndUser Tagging:

 Yes

 

Is TagViewer:

 View GTM: Yes

 View GTO: Yes

 View EUS: Yes

 View EUT: Yes

 

Display Tags (Final):

 Yes

 

Display Menu For Tag Additions (Final):

 Yes

 

Display Menu For Tag Additions by Inbox Owners (Final):

 Yes

 

Tag Addition Role(s) for [John01]:

 GTM Role: No

 GTO Role: Yes

 

 

----------------------------------------------------------------------

Some settings in effect:

 

 Effective Dates - (Will Enforce if set): Both - Effective From & Valid Thru

 

 EndUser Public Tagging Allowed:  Yes

 

 Tagging By Users with No Inbox, Allowed:  Yes

 

 

EM WebPlus Tools, Integration, SDK 5.0


This guide section describes Tools, Integration and SDK - WsGen features for developers. WsGen tool to generate Web Services provides excellent means for business integration with other applications and solutions.

 

 

Tools Menu

 

Tools menu has sections and links to select different option screens as below.

 

Screen Snapshot:

 

 

Web Services Tools (Generate Web Services For EM Inbox Objects) : 

  • Web Services (WsGen) 

 

 

Integration Tools:

 

Bringing Existing Database Objects (Tables) into EM Inbox : 

  • Import Objects 
  • Generate Table Integration Scripts (All Tables) 

 

EM Inbox Objects migration to Database Objects (Tables) : 

  • Generate Table Schema (All Tables)  

 

 

Reports        

  • Report - No Of Categories (Folders/Tables/WebProjects)
  • Report - Tables with Data Records (excluding deleted/archived)
  • Report - Tables with Archived/Deleted Data Records

 

  • Report - User Id (Account) Privileges Information
  • Report - User Blocked Information 

 

For Advanced Users: 

  • Report - Table Linked Data Information 

 

For Super Users: 

  • Report - License Information 

 

  • Report - [All Users] As Selected Below: 
    • Report Option:  
      • Users List
      • No Of Categories (Folders/Tables/WebProjects)
      • Tables with Data Records (excluding deleted/archived)
      • Tables with Archived/Deleted Data Records
      • Table Linked Data Information 
    • Report Parameters
      • For User Id(s) Starting With [Blank=All]:  A%
      • Only For User List: Sort By:  
        • Created Down, User Id Up, User Id Down, Updated Down 
  • Report - All Object Ids Current Seq. Values 

 

* When available

 

 

 

Chapter 1: Tools - Reports

 

 

 

Reports

 

This section lists reports that can be viewed online.

 

Report - No Of Categories (Folders/Tables/WebProjects)

This option reports on total No Of Categories as per (Folders/Tables/WebProjects) for the user.

 

Screen Snapshot:

 

 

Report - Tables with Data Records (excluding deleted/archived)

This option reports on EM Tables [DEF] (not linked to database) having data records only, and lists the table name and total number of Data Records (excluding deleted/archived).

 

Screen Snapshot:

 

 

Report - Tables with Archived/Deleted Data Records

This option reports on EM Tables [DEF] (not linked to database) having either deleted or archived data records only, and lists the table name and total number of Deleted/Archived Data Records as relevant.

 

Screen Snapshot:

 

 

Report - User Id (Account) Privileges Information 

 

Report - User Blocked Information 

 

For Advanced Users: 

Report - Table Linked Data Information 

 

For Super Users: 

Report - License Information 

 

Report - [All Users] As Selected Below: 

Report Option:  

  • Users List
  • No Of Categories (Folders/Tables/WebProjects)
  • Tables with Data Records (excluding deleted/archived)
  • Tables with Archived/Deleted Data Records
  • Table Linked Data Information 

Parameters:

  • For User Id(s) Starting With [Blank=All]:   
  • Only For User List: Sort By:  
    • Created Down
    • User Id Up
    • User Id Down
    • Updated Down 

 

 Report - All Object Ids Current Seq. Values 

 

 

 

 

Chapter 2: Integration Tools

 

 

Bringing Existing Database Objects (Tables) into EM Inbox

 

 

Import Objects

This option allows to import definitions of physical database objects (tables) as EM Object definitions. Please see separate section below.

 

Generate Table Integration Scripts (All Tables)

Table Integration Scripts: Generates SQL DDL, DML and also stored procedure, trigger scripts. Use these to integrate with existing database objects.

 

 

Import Objects

 

[Note: Available with Oracle, MS SQL Server but not available with MS Access]

This option allows to import definitions of physical database objects (tables) as EM Object definitions. First enter the parameters on Parameters screen to query on database objects and specify actions. The search results will be displayed next.

 

For Advanced Users Only: For Import Objects the User must have Advanced User privileges.

Import Object Parameters Screen

 

Screen Snapshot:

 

Import Objects Options Screen has following information fields and menu options.

 

 

Database Objects:

NOTE: The parameters required depend upon your database type as Oracle, MS SQL Server, etc. Use % as wild card search character rather than leaving “Catalog/Schema/name Like” to blank.

 

Catalog

Name of database catalog.

 

Schema

Name of database schema.

 

Name Like

Name of database object.

 

Or, Display All

If checked means: Ignore “Name Like” above and query all names.

 

Type

Database Object Type.

 

Limit Rows

Query records limit (TABLE level).

 

Level

One Of: 1-TABLE/2-FIELDS, where:

1-TABLE = Table Name level only, no fields.

2-FIELDS = Table field level.

 

Action

Action allowed are one of: List/ListImport, where:

List = Query and list database object info.

ListImport = Query, list database object info and import as EM Object.

 

Excl “EM_%” Tbl?

If checked means: Exclude the EM tables i.e. all tables starting with “EM_” from fetching of query.

 

Excl EM Fields?

If checked means: Exclude the EM table fields: CL_USER, CL_VAL_ID from the column query fetching.

 

Set Default Fld Disp Sizes after Import?

If checked means: Reset the default size and display sizes for all data types except following:

For CHAR and HYPERLINK size is retained.

 

 

Import Object Search Results

 

Screen Snapshot:

 

Import Objects Search Results Screen has following information fields and menu options.

 

 

Srl

Srl no.

 

Catalog

Name of database catalog.

 

Schema

Name of database schema.

 

Name

Name of database object.

 

Type

Type of database object.

 

Remark

Remark

 

Import Status

One Of: Ok/(blank).

 

Table Column/Field Info

Info as below for each column:

Srl

Column Name

Type

Size

Decimals

Nullable

 

And at Table level Columns Imported Status:

Ok/(blank).

 

 

 

Generate Table Integration Scripts (All Tables)

 

Table Integration Scripts

 

Table Integration Scripts Menu:

 

Req 1:  Table was Imported via [Options --> Import Objects] 

Req 2:  Table Linked via [Table Menu --> Link to] 

 

Step 1:  Script: Alter Table Add EM Columns 

(Optional Step) 2:  Script: Alter Table Modify EM Columns 

 

Step 3:  Script: Procedure to Make Existing Records Accessible 

Step 4:  Script: Execute commands (Procedure) to Make Existing Records Accessible 

 

Step 4-A:  Check existing data records now accessible via [Table Menu --> View Data -All] 

 

Step 5:  Script: Table Trigger to handle Insert from other Apps 

Step 5-A:  New Added records from other apps will be accessible from now on. 

 

Step 6:  Script: Misc SQL 

 

Info 1:  Get - Table Linked Data Information via [emutil.EjTable_ln_data_rep UserID TableName] 

 

 

 

EM Inbox Objects migration to Database Objects (Tables) :

 

This section lists integration tools for EM Inbox Objects migration to Database Objects (Tables).

 

 

Generate Table Schema (All Tables)

 

 

Generate Table Schema

This option generates a SQL schema of EM Tables targeted for the database being used. A create table SQL statement is generated for all EM Tables, the EM key information is not processed.

 

Screen Snapshot:

 

There are options for following on the report:

[CREATE TABLE ALL] : Will create all the tables in database.

[Create Table] : Will create selected table in database.

[Capture SQL] : Will generate create table schema and display in text box for capturing.

 

 

 

 

Chapter 3: SDK - Web Services

 

 

The Web Services Menu provides tools to generate Java web services source code from EM Objects.

 

 

Web Services – Menu

 

Web Services menu has links to select different options below.

 

 

Web Services Options

  • Web Services
  • Generate Session  All

 

 

Naming Guidelines, Conversions and Data Type Mapping

 

This section describes naming guidelines , conversions performed by Generate screens and data type mapping between EM Types and XML or Java types.

 

Naming Guidelines and Conversions

Naming guidelines (For Table, Field, WP & Scr Title) are important for trouble-free: generated XML name conversion to java name, by XJC, etc.!

 

Naming Guidelines: (For Table, Field, WP & Scr Title)

1. Naming convention: Names should begin uppercase for each word token separated by '_' or digits e.g. Table_Orders, Table50Orders, Table

2. Table Name and WP Names should follow #1.

3. Table Field Name should follow #1. First letter lowercase is ok.

4. WP Scr Title Name used for web services method should follow #1 but MUST not have any digits.

5. Please refer to JAXB documentation for more details.

 

Naming Conversions performed by WsGen: (For Table, Field, WP & Scr Title)

1. Non-Letter chars are removed e.g. ^, *, [, ], +, /, =, etc.

2. Underscores '_' are removed.

3. All blank spaces ' ' are removed.

4. First Letter converted to Uppercase for Table Name and WP Name.

 

Data Type Mapping

 

EM Field Type to XML Type Mapping:

CHAR : string

NUMBER : integer

MONEY : float

FLOAT : float

DATE : dateTime

DATETIME : dateTime

TIME : Time

BOOLEAN : boolean

TEXTS : string

TEXT : string

HYPERLINK : string

FILE : base64Binary

STREAM : base64Binary

 

EM Field Type to Java Type Mapping:

CHAR : String

NUMBER : long

MONEY : float

FLOAT : float

DATE : XMLGregorianCalendar

DATETIME : XMLGregorianCalendar

TIME : XMLGregorianCalendar

BOOLEAN : boolean

TEXTS : String

TEXT : String

HYPERLINK : String

FILE : byte[]

STREAM : byte[]

 

 

Generate (Session - All)

 

Use this screen to generate web services java source files from earlier marked objects.

 

Generate Session

This menu option will select the objects marked in present session only.

 

Generate All

This menu option will select the objects marked in all sessions including present one. The screens and options displayed are same.

 

The markings for Generate (or Mail Compose) can be cleared from EM Inbox - Explorer screen link options: ClearSend Session – All.

 

Note: Please make sure you have selected appropriate Selection Level (Tree/One Level) for Explorer Type markings.

 

 

Screen Snapshot:

 

Web Services Generate Screen has following information fields and menu options.

 

 

 

Marked For Send Info:

 

 

Type

One Of:

Explorer = Marked in EM Inbox -  Explorer as a category.

Object = Marked in object menu e.g. Table, WebProject, etc.

 

Send Object

Details EM Object type and name.

For Oracle database: Lists the complete sub-tree of folder (txt) type object, as well.

 

Id

Object Id.

 

Object Info

Applies only to “Object” type markings. Gives following info as applicable:

[ Parent Id, Form Id, Query Id, Data Record Id, WebProject Id, WP Screen Id, App Id]

 

User Info [Inbox/App DataGrp Sign-In]

Applies only to “Object” type markings. Gives following info as applicable:

User Id, Data Group, Sign-In User Id

 

 

 

 

Selection Options For Explorer Type:

 

 

Selection Level

One Of: Tree/One Level. Where,

Tree = Select the complete tree of each explorer marked folder (txt) type object.

One Level = Select only the explorer marked folder (txt) type object.

Note: Duplicate selections with equal or lower object level markings are ignored.

 

 

Submit will create the java source tree under folder specified in configuration parameter: “em.file_dest_dir”.

 

The WsGen generates the java and xml source files for jaxb, jaxws, jaxm and clients (jaxws, jaxm).

 

Depending upon the selection the source is generated, following illustrates sample generated source tree.

 

Examples:

 

em.file_dest_dir= E:\tmp\em_files\

 

The WsGen generated source is under:

WSGEN

 

So, Java web services source generated by user “DEMO” would be in folder (with Id 10127) :

E:\tmp\em_files\WSGEN\DEMO\WS_10127

 

The sub-dirs under this folder are like:

.

./common

./TableServices

./TableServices/common

./TableServices/common/jaxb

./TableServices/CUSTOMER

./TableServices/CUSTOMER/jaxb

./TableServices/CUSTOMER/jaxb/src

./TableServices/CUSTOMER/jaxm

./TableServices/CUSTOMER/jaxm/etc

./TableServices/CUSTOMER/jaxm/src

./TableServices/CUSTOMER/jaxws

./TableServices/CUSTOMER/jaxws/etc

./TableServices/CUSTOMER/jaxws/src

./TableServices/CUSTOMER/jaxwsClient

./TableServices/CUSTOMER/jaxwsClient/src

./TableServices/CUSTOMER/schema

./WPServices

./WPServices/common

./WPServices/common/jaxb

./WPServices/Wp2

./WPServices/Wp2/jaxb

./WPServices/Wp2/jaxb/src

./WPServices/Wp2/jaxm

./WPServices/Wp2/jaxm/etc

./WPServices/Wp2/jaxm/src

./WPServices/Wp2/jaxws

./WPServices/Wp2/jaxws/etc

./WPServices/Wp2/jaxws/src

./WPServices/Wp2/jaxwsClient

./WPServices/Wp2/jaxwsClient/src

./WPServices/Wp2/schema

 

 

 

Deploying Generated Web Services

 

 

Note: For instructions on how to compile the jaxb, web services, deploy them and clients, please refer to “Administrator Guide: Installation : Installation and Set-up of SDK : Compiling the WsGen generated source files”.

 

This section describes initial features, we will be doing a lot of details and enhancements to the documentation. The developers will get good insight from browsing the directory structures and going thru generated files.

 

Runtime Considerations For Deployed Web Services :

 

Following should be considered:

 

  • Following Screen Modes are supported:

Input, InputMulti,

EditRecordNo,

Display (With only Query Modes: DisplayAll, InputQuery),

DisplayRecordNo,

  • Following Screen Modes are not supported:

DisplayCombined

Edit, EditMulti,

EditRecordNoDis, CopyAndEdit,

CallBean, CallBeanStatus

DisplayList,

TableCopy, TableCopyCheck

TableUpdCheck, TableUpd

    • The generated source will have functions generated for not supported modes but they will return null by default. There will be comment like below in the code:

            /** Method operation not available **/

  • The Data Grp and App User are set as Inbox/App Owner. E.g. For Inbox User Id UnivAdmission, the Data Grp and App User will be set to: UnivAdmission.
  • Multiple Data Grps are not supported.
  • Retrieval of data for fields of type FILE is supported with additional functions which are only generated in “Display” screen Mode based web service. The functions end with specific words E.g. ____getfilefldfile() ____putfilefldfile().
  • The generated service code for each function has code section which is commented by default. Please edit and use this section to customize and use the web service further. E.g. the code is enclosed with:

            /******* TO DEFINE YOUR OWN Method, Use Following ***

            DispALl wsForm1 = new DispALl();

            TblAll tbl1 = new TblAll();

            TblAllRecords tblrecs1 = new TblAllRecords();

            TblAllRecords.TblAllRec tblrec1 = new TblAllRecords.TblAllRec();

            TblAllFlds tblflds1 = new TblAllFlds();

 

            //FldChar1 : Java Data Type [String], XML Schema Type [string] 

            //tblflds1.getFldChar1(); 

            //tblflds1.setFldChar1(); //ABCD_string

            System.out.println("    FldChar1 : " + tblflds1.getFldChar1() );

            //FldNum : Java Data Type [long], XML Schema Type [integer] 

            //tblflds1.getFldNum(); 

            //tblflds1.setFldNum(); //1234

            System.out.println("    FldNum : " + tblflds1.getFldNum() );

           

           

            ******* TO DEFINE YOUR OWN Method, Use Above ***/

  • Please note: For Input / Edit Modes and Screen Query Input Modes, the data record is expected in fixed Java arrays (samples are generated and available in client stubs.) Use of xml schema based data record is not supported yet.
  • The output of data records in Display Modes is in xml schema based form.

 

 

 

 

Appendix A: Administrator Information

 

This section describes some information from Administrator Guide which is relevant to end users and developers as well.

 

 

EM Configuration Parameters (Default / Plan / User)

 

 

How to use EM Configuration Parameters?

 

  • EM Configuration Parameters file contains Instance (Site) and User specific configurable parameters.
  • This file can be overridden by a specific file for a “Plan” or “User”.

 

How to use Plan or User specific EM Configuration Parameters?

 

  • Assign a Plan and/or User flag for User via emutil.EjUser_prop
  • Create a parameter file for this Plan and/or User.
  • This New file values take effect at next Server Start-up.
  • Please refer to Administrator Guide for exact details on this procedure.

 

Which Parameters can be override via Plan / User files?

 

Following configurable parameters can be overridden from Plan or User files:

 

em.param.em_mail_out

em.param.em_mail_in

em.param.em_mail_param

 

em.param.records_per_form

em.param.da_records_per_form

em.param.em_user_da

 

em.param.max_records_per_form

 

em.param.file_upload_size_kb

em.param.file_download_size_kb

 

em.param.em_block_users_apps (Default set to ALL)

 

em.param.em_easy_qry_form

em.param.em_app_mail

 

em.param.em_tg_<AppId|ALL>

em.param.em_tg_tagp_<AppId|ALL>

em.param.em_tg_ext_<AppId|ALL>

 

em.param.em_enable_cust_html (Excluding WP_Exec parts)

em.param.em_disp_htmlObj

 

em.param.em_check_si_dur_days

 

 

 

Appendix B: General Specifications

 

 

 

Characters not supported or converted

 

 

Following sections describes chars that are allowed or that are not supported:

  • Explorer Folder / Category / Table Names:
    • Following chars are not supported and removed from input entry: # & % “ < >
  • Table Fields Data Entry:
    • All Field Data Types (except TEXT and TEXTS): Following chars are not supported and removed from entry: “
        • Please use instead &quot; while entry.
    • All Field Data Types:  Following chars are converted while display: < > to: &lt; &gt;  except when
      • For TEXT and TEXTS data types: while display: the tag is a link like <A HREF=””></A> or <a href=””></a>
    • For TEXT and TEXTS data types: while display: newlines (\r) are replaced by <br>
    • Hyperlink data types: Following chars are not supported and removed from input entry: “ < >
    • All Numeric Data Types [NUMBER, MONEY, FLOAT]:  The entered data is parsed for valid number of given data type. If there is invalid data entry (Number parse Exception) then value of Zero (0) is used. Some examples of valid numbers given below.
      • NUMBER: 400, 500, 6060
      • MONEY: 400.50, 555.75, 8080.550
      • FLOAT: 400.50E10, 555.6670
    • All Date types data entry must be valid as per the input format in effect and parsing of date by system. These word tokens are also allowed for DATE, DATETIME and TIME types: now, today 

 

 

Using HTML Editor

 

Inputting the data for TEXT type fields has option to enable HTML Editor.

Mail Send uses HTML Editor for Mail Text entry.

 

Caution: Please use “Save” (Disk Icon) button on the HTML Editor frequently, which copies the text into underlying field on screen. Without this if you click Submit/Send and go to next screen and now come back by Browser BACK button, the data entered in HTML Editor is lost.

 

 

 

Database Specific Features or Feature Restrictions

 

 

Following section lists out the features that are restricted or not supported with one or more databases other than MySQL. MySQL is primary reference platform supporting all features.

 

 

Feature Restrictions Table For MS SQL Server, Oracle, MS Access:

 

Note:

  • Type: LM = Limitation, NS = Not Supported
  •  Database Flag: ‘Y’ = Applies to the database, ‘-‘ = Does not apply.

 

 

Category/Heading:

Description

Type

MS SQL

Oracle

MS Access

EM Configuration Parameters

 

 

 

 

 

em.param.file_dest

Value of 1=Database, not supported. Use value 2=Disk, e.g. em.param.file_dest=2

LM

Y

Y

Y

em.param.em_check_si_dur_days

Not supported, Leave value to 0, e.g. em.param.em_check_si_dur_days=0

NS

-

Y

Y

Misc

 

 

 

 

 

Unicode (UTF-8) Not Supported

Unicode (UTF-8) encoding multi-byte characters not supported. Only single-byte Latin1 characters supported. Storing and retrieving UTF-8 characters from database not supported.

NS

Y

-

Y

 

 

 

 

 

 

 

 

 

 

 

Appendix C: Screen List

 

Select the link below to view a list of all the screens:


Screen List


Table Of Contents

 

EasyManage Platform (EM WebPlus Suite 5.0)

Copyright © 2021 EasyManage.com All Rights Reserved.