Meridium APM Data Management
Meridium APM Data Management
V3.6.1.6.0
Copyright © 2017 General Electric Company. All rights reserved. • Page 1 of 280
Copyright and Legal
Copyright © 2017 General Electric Company. All rights reserved. • Page 2 of 280
About This Document
Note: If you do not have access to the Meridium APM Documentation Website, con-
tact GE Global Support (https://www.ge.com/digital/asset-performance-management).
Copyright © 2017 General Electric Company. All rights reserved. • Page 3 of 280
Table of Contents
Table of Contents
Meridium APM Data Management 1
Copyright and Legal 2
About This Document 3
Table of Contents 4
What Is Data Management? 11
Options for Creating Records 12
Creating a New Record from Scratch 13
Creating a New Record by Copying an Existing Record 15
Creating a New Record in the Bulk Data Form 16
Creating a New Record and Populating Fields Automatically 17
Options for Finding Records 18
Accessing the Search Page 19
Overview of the Search Page 20
Search Criteria Section 21
Overview of the Search Results Section 27
When Search Results Include Records From Two Related Families 29
When Search Results Include Field Conditions 30
Using the Shortcut Menu in the Search Results 31
Search Type Menu 32
Common Tasks Menu 33
Search Types 34
Performing a Keyword Search 35
About Hiding the Keyword Search Functionality 38
Hiding the Keyword Search Functionality 39
Performing a Simple Search 40
Example of a Simple Search that Includes Query Prompts 43
Baseline Simple Search Queries 44
Guidelines for Creating Simple Search Queries 45
Copyright © 2017 General Electric Company. All rights reserved. • Page 4 of 280
Table of Contents
Copyright © 2017 General Electric Company. All rights reserved. • Page 5 of 280
Table of Contents
Copyright © 2017 General Electric Company. All rights reserved. • Page 6 of 280
Table of Contents
Copyright © 2017 General Electric Company. All rights reserved. • Page 7 of 280
Table of Contents
Copyright © 2017 General Electric Company. All rights reserved. • Page 8 of 280
Table of Contents
Copyright © 2017 General Electric Company. All rights reserved. • Page 9 of 280
Table of Contents
Copyright © 2017 General Electric Company. All rights reserved. • Page 10 of 280
What Is Data Management?
Copyright © 2017 General Electric Company. All rights reserved. • Page 11 of 280
Options for Creating Records
Copyright © 2017 General Electric Company. All rights reserved. • Page 12 of 280
Creating a New Record from Scratch
2. In the list of families, select the family to which the new record will belong, and
click OK.
-or-
Click the button to browse a hierarchical view of families, select the desired
family, and click OK.
The list will display only families for which you have been granted Insert per-
missions and whose Family is Managed by Product Module check box is cleared
in the Configuration Manager.
The Record Manager displays the datasheet for the family you selected, and the
record hierarchy displays a new branch for the new record.
3. In the Datasheet list, choose the datasheet that you want to use to create the new
record.
Note: The Datasheet list will display multiple options only if more than one
datasheet has been configured for the family that you selected.
Copyright © 2017 General Electric Company. All rights reserved. • Page 13 of 280
Creating a New Record from Scratch
If you want to save the record and immediately create another new record in the
same family, on the Common Tasks menu, click the Save and New link.
The record is saved to the database.
Copyright © 2017 General Electric Company. All rights reserved. • Page 14 of 280
Creating a New Record by Copying an Existing Record
Note: ID fields are designated as such via the Configuration Manager. While ID
fields cannot necessarily be distinguished from non-ID fields in the Meridium APM
Framework application, you can assume that any values not copied from the original
record to the new are stored in ID fields.
Note that creating a new record by copying an existing record will create the new record
in the same family as the existing record. If you prefer to create a brand new, original
record, or if you want to create a record in a different family, you can create a new
record from scratch.
To create a new record by copying an existing record:
1. In the Meridium APM Framework, find the desired record, and open it in the
Record Manager.
2. In the Record Manager, on the Common Tasks menu, click the Copy link.
A new datasheet appears, displaying the contents of the copied record.
3. Modify the record as desired.
4. If you want to save the record and continue viewing it in the Record Manager, on
the Common Tasks menu, click the Save link.
-or-
If you want to save the record and immediately create another new record in the
same family, on the Common Tasks menu, click the Save and New link.
Note: This will create a new record from scratch rather than another copy.
The new record is saved to the database.
Copyright © 2017 General Electric Company. All rights reserved. • Page 15 of 280
Creating a New Record in the Bulk Data Form
Note: When you create a new record in the Bulk Data Form, Default and Disable
rules are not executed when the new row is first added. Instead, these rules will fire
only after you have entered data into some field.
Note: To add a new row in the Bulk Data Form, click a cell outside of the row
in which you are currently working.
Copyright © 2017 General Electric Company. All rights reserved. • Page 16 of 280
Creating a New Record and Populating Fields Automatically
ŒHint: By placing this type of URL on the Associated Pages menu in the Record Man-
ager, you can map value from the current record to a new record. You would accom-
plish this in the same way that you pass values from records into any URL on the
Associated Pages menu, replacing the parameter value with the field ID of the field
whose value that you want to map to the new record.
Copyright © 2017 General Electric Company. All rights reserved. • Page 17 of 280
Options for Finding Records
Performing Searches
Searches lets you find records in the database that meet specific criteria. After you find
the desired records, you can open them in the Record Manager or the Bulk Data Form.
You can perform a search from any page in the Meridium APM Framework application
at any time during your session.
You can perform the following types of searches:
l A Keyword Search.
Note: Keyword Searches are available only if an administrative user has not
hidden the functionality.
l A Simple Search.
l An Advanced Search.
After you have performed a search, you can browse the search results and open any
record that was retrieved using the defined search criteria. Additionally, you can save
any search to the Catalog so that it can be used again later.
Browser
The Browser lets you view a hierarchical list of nodes representing:
l Entity families that exist in the database.
l Records that belong to each entity family.
l Records that are linked to one another.
After you have located the desired record in the Browser, you can open it in the Record
Manager.
Copyright © 2017 General Electric Company. All rights reserved. • Page 18 of 280
Accessing the Search Page
When you first access the Search page, the Simple Search workspace is displayed by
default. After you have accessed the Search page once, when you return to it, the search
type that appears (Simple, Keyword, or Advanced) corresponds to the type of search you
last performed. Note that you can select a different search type by clicking the link for
the desired type on the Search Type menu.
Note: The features of the Search page also appear on stand-alone windows in vari-
ous places throughout the Meridium APM Framework application (e.g., the Find Now
window). In most cases, the features available on these windows are the same as
those available on the Search page.
Copyright © 2017 General Electric Company. All rights reserved. • Page 19 of 280
Overview of the Search Page
Copyright © 2017 General Electric Company. All rights reserved. • Page 20 of 280
Search Criteria Section
Find Now Initiates the search using the Yes Yes Yes
button criteria that you have defined.
Stop but- After displaying a message Yes Yes Yes
ton indicating that the search has
been cancelled, displays an
empty search results section.
New Clears all values currently dis- Yes Yes Yes
Search but- played in the search criteria
ton section so that you can begin a
new search.
Look For Accepts any alphanumeric Yes Yes No
text box value, including special char-
acters. The value that you type *In an
will be used to limit the results Advanced
to records containing that Search, to
word within the Record ID. If limit res-
you specify a keyword, your res- ults to
ults will contain records that records
match your family criteria and containing
contain the keyword that you specific
specified. text within
their
record IDs,
use the
Define
Conditions
section
and the
Search
Conditions
section.
Copyright © 2017 General Electric Company. All rights reserved. • Page 21 of 280
Search Criteria Section
Copyright © 2017 General Electric Company. All rights reserved. • Page 22 of 280
Search Criteria Section
Copyright © 2017 General Electric Company. All rights reserved. • Page 23 of 280
Search Criteria Section
Copyright © 2017 General Electric Company. All rights reserved. • Page 24 of 280
Search Criteria Section
Copyright © 2017 General Electric Company. All rights reserved. • Page 25 of 280
Search Criteria Section
Copyright © 2017 General Electric Company. All rights reserved. • Page 26 of 280
Overview of the Search Results Section
Note: If your search criteria include a related family or field conditions, additional
columns will be displayed in the search results.
Each row of the search results represents one record. All records listed in this image
belong to the Equipment family, as indicated by the family name in the left column of
the search results. The Record ID of each record is displayed in the right column of the
search results. For example, the Record ID of the first record in the results is A0006-117
~000000000001071114 ~ MIXER - TANK 790 ~ Mixer ~ ROT MIX MIX. You can open the
associated record in either Record Manager or the Bulk Data Form.
Note that the search results will display results for any sub families that are linked to a
parent family. For example, if you search in the parent Recommendation family, the
search results would display records for all the Recommendation families, including
Meridium General Recommendation, RBI Recommendation, and so on.
With the exception of the Keyword Search, the search results will display records only
from active families. In other words, if a family is inactive, records in that family will not
be returned in search results.
At the bottom of the search results section, the following information and options are
displayed:
Copyright © 2017 General Electric Company. All rights reserved. • Page 27 of 280
Overview of the Search Results Section
l Page X of X: Indicates the total number of pages in your search results and iden-
tifies the page that is currently displayed. You can type a different number in the
Page text box and then press Enter to navigate directly to another page. This text
box is enabled only if the text X records found is displayed (i.e., if the Display
record count link appears, you cannot type a value in the Page X of X text box).
Note: If you are viewing search results on a stand-alone window, you will need
to press the Tab key instead of the Enter key to navigate to another page in the
search results.
l X records found: Indicates the total number of records found using the specified
search criteria. If the number of records found is greater than the number in the
Page Size text box, the Display record count link will appear instead of the actual
number of records found. You can click the Display record count link to view the
total number of returned records.
l First: Displays the firstpage of the search results. This link is enabled when there is
more than one page of search results and when you are currently viewing any
page other than the first page.
l Previous: Displays the previouspage of the search results. This link is enabled
when there is more than one page of search results and when you are currently
viewing any page other than the first page.
l Next: Displays the nextpage of the search results. This link is enabled when there
is more than one page of search results and when you are currently viewing any
page other than the last page.
l Last: Displays the last page of the search results. This link is enabled when there is
more than one page of search results and when you are currently viewing any
page other than the last page.
l Page Size: Indicates the number of records displayed per page. The page size is
set to 1000 by default, but you can type a different number and press the Tab key
to change the number of records that are displayed on each page.
Copyright © 2017 General Electric Company. All rights reserved. • Page 28 of 280
When Search Results Include Records From Two Related Families
In this image, you can see that the Record ID column contains a link to a record in the
Air Cooled Heat Exchanger family. The Linked Record ID column contains a link to a
record in the Reference Document family.
Copyright © 2017 General Electric Company. All rights reserved. • Page 29 of 280
When Search Results Include Field Conditions
You can see that an additional Asset ID column is displayed in the results, showing the
field condition that you defined for the Asset ID field. An additional column will be dis-
played in the results for every field condition that you include in your search criteria.
Note: If you specify a field condition using either the Is null or Is not null operator,
an additional column will not appear in the search results.
Copyright © 2017 General Electric Company. All rights reserved. • Page 30 of 280
Using the Shortcut Menu in the Search Results
Copyright © 2017 General Electric Company. All rights reserved. • Page 31 of 280
Search Type Menu
Note: The Keyword search link is available only if an administrative user has
not hidden the functionality.
l Simple search: Displays the Simple Search workspace, where you can perform a
Simple Search.
l Advanced search: Displays the Advanced Search workspace, where you can per-
form an Advanced Search.
Copyright © 2017 General Electric Company. All rights reserved. • Page 32 of 280
Common Tasks Menu
The Common Tasks menu on the Search page contains the following links:
l New search: Clears the current search criteria and results so that you can begin a
new search.
l Open a search: Displays the Open a saved search dialog box, where you can open
a search that exists in the Catalog.
l Save this search: Displays the Save this search dialog box, where you can save the
current search. If you are viewing a search that was previously saved and has been
modified, clicking this link will save your changes to the existing search. This link
is enabled only if results are displayed in the search results section.
l Save this search as: Displays the Save this search dialog box, where you can save
an existing search with a different name or to a different location. This link is
enabled only when you are viewing a saved search.
l Delete this search: Displays a confirmation message, asking if you really want to
delete the search. This link is enabled only when you are viewing a saved search.
l Print search results: Displays the search results in the Preview window, from
which you can print the search results.
l Send to: Displays a submenu with options that let you provide a link to the current
page on your desktop (create shortcut), in an email message, or on a Home Page.
This link is enabled only when you are viewing a saved search.
l Help: Displays the context-sensitive Help topic for the Search page.
Copyright © 2017 General Electric Company. All rights reserved. • Page 33 of 280
Search Types
Search Types
You can perform the following types of searches:
l Keyword Search: Lets you specify a keyword and then find all the records in the
Meridium APM database that contain that keyword within their record IDs.
l Simple Search: Lets you search for records within a selected entity family. You can
optionally refine your search by specifying a related family or by specifying a
keyword to find within the record IDs of all records.
l Advanced Search: Lets you search for records within a selected family. You can
optionally refine your search by specifying a related family or by defining field con-
ditions.
Copyright © 2017 General Electric Company. All rights reserved. • Page 34 of 280
Performing a Keyword Search
Using a Keyword Search, you can specify a keyword and search for it within the Record
ID of any record in the Meridium APM database. The search results will contain records
that contain the keyword you specified, as long as that word appears at the beginning of
any separate word in the Record ID.
For example, if you search for the keyword pump, the search results will contain
records where the Record ID is pump, centrifugal pump, pump-101, and so on. It will
not, however, return records where the Record ID is 101-pump since pump is the last
word instead of the first word of the phrase 101-pump.
To perform a Keyword Search, the keyword that you specify must include at least two
characters. Otherwise, the Find Now button will remain disabled.
Note: Keyword Search results will include records in Active families only. Records
belonging to Inactive families that contain the specified keywords will not be included
in the results. You can find records in Inactive families using a query.
Copyright © 2017 General Electric Company. All rights reserved. • Page 35 of 280
Performing a Keyword Search
2. If the Keyword Search workspace appears on the Search page, proceed to step 3
of these instructions. If the Keyword Search workspace does not appear, on the
Search Type menu, click the Keyword search link.
The Keyword Search workspace appears.
3. In the Look For text box, type the keyword that you want to find in a Record ID.
The keyword must contain at least two characters. It can contain any alpha-
numeric value and any special character.
Copyright © 2017 General Electric Company. All rights reserved. • Page 36 of 280
Performing a Keyword Search
Copyright © 2017 General Electric Company. All rights reserved. • Page 37 of 280
About Hiding the Keyword Search Functionality
Copyright © 2017 General Electric Company. All rights reserved. • Page 38 of 280
Hiding the Keyword Search Functionality
Copyright © 2017 General Electric Company. All rights reserved. • Page 39 of 280
Performing a Simple Search
2. If the Simple Search workspace appears on the Search page, proceed to step 3 of
these instructions. If the Simple Search workspace does not appear, on the Search
Type menu, click the Simple search link.
The Simple Search workspace appears.
3. In the Search In list, select the desired family. Your search results will include only
the records that belong to this family. The list will display only families to which
you have been granted View permissions in the Configuration Manager. This field
is required.
After you select a family in the Search In list:
Copyright © 2017 General Electric Company. All rights reserved. • Page 40 of 280
Performing a Simple Search
l If the family is related to one or more families, the Linked To list will become
enabled. If the selected family is not related to any other families, the Linked To
list will remain disabled, and you can proceed to step 5.
l The Look For text box becomes enabled.
l If you selected a family for which a simple search query has been defined via the
Configuration Manager, additional search criteria appear in the search criteria sec-
tion, as shown in the following image.
4. In the Linked To list, if desired, select a family that is related to the family you
selected in the Search In list. If you select a family in the Linked To list, the search
will return only the records that belong to the family in the Search In list that are
also linked to a record belonging to a family in the Linked To list.
The Linked To list contains only the families that are related to the family selected
in the Search In list. It also contains only the families to which you have been gran-
ted View permissions in the Configuration Manager. In addition, the list will dis-
play a family only if you have been granted View permissions to the relationship
family that relates that family to the family in the Search In list.
For example, if you selected Pump in the Search In list, and the Pump family is
related to the Failure family through the Asset Has Failure relationship, the Linked
To list will display Failure only if you have View permissions to the Failure family
and the Asset Has Failure relationship family.
5. In the Look For field, type a keyword to limit your results to records containing
that word within the Record ID. If you specify a keyword, your results will contain
records that match your family criteria and contain the keyword that you spe-
cified. A keyword can contain any number of characters, any alphanumeric value,
and any special character. A keyword is optional.
6. If you want the search to be case-sensitive, select the Match Case? check box.
Selecting the check box indicates that you want to return only the records that con-
tain the keyword you specified using the exact case that you specified in the Look
For text box.
-or-
Copyright © 2017 General Electric Company. All rights reserved. • Page 41 of 280
Performing a Simple Search
If you do not want the search to be case-sensitive, do not select the Match Case?
check box.
Note: The Match Case? option works only on Oracle schemas. When you per-
form a search using a SQL Server database, the search will be case-insensitive
even when the Match Case? check box is selected.
7. If additional search criteria appear below the Match Case check box:
l If you want to refine the search results further to include only records with
specific values in those fields, select the desired values in the available
prompts.
-or-
l If you do not want to refine the search results further to include only records with
specific values in those fields, clear the Include Search Fields check box.
Note: If the underlying query prompts have been configured to contain the
value All by default, if you do not want to refine the search results further,
you can accept the default prompt values without clearing the Include Search
Fields check box.
Copyright © 2017 General Electric Company. All rights reserved. • Page 42 of 280
Example of a Simple Search that Includes Query Prompts
When searching for Equipment records, you can select a value in the Category, Class,
and Type prompts to further limit the search results to include only Equipment records
with those values in the Taxonomy Category, Taxonomy Class, and Taxonomy Type
fields.
Copyright © 2017 General Electric Company. All rights reserved. • Page 43 of 280
Baseline Simple Search Queries
Copyright © 2017 General Electric Company. All rights reserved. • Page 44 of 280
Guidelines for Creating Simple Search Queries
Copyright © 2017 General Electric Company. All rights reserved. • Page 45 of 280
About Associating Families with Simple Search Queries
When searching for Equipment records, the user can select a value in the Category,
Class, and Type prompts to further limit the search results to include only Equipment
records with those values in the Taxonomy Category, Taxonomy Class, and Taxonomy
Type fields.
In order to associate a family with a Simple Search query via the Configuration Manager,
the following conditions must be met:
l The query must already exist in the Catalog in the Meridium APM Framework
application.
Copyright © 2017 General Electric Company. All rights reserved. • Page 46 of 280
About Associating Families with Simple Search Queries
l The query select statement must include only the Entity Key. The query can con-
tain other fields, but they must be excluded from the select statement.
Copyright © 2017 General Electric Company. All rights reserved. • Page 47 of 280
Associating a Family with a Simple Search Query
Copyright © 2017 General Electric Company. All rights reserved. • Page 48 of 280
Associating a Family with a Simple Search Query
4. Navigate to the Catalog folder in which the query is stored, select the query, and
click the Open button.
The Search Query dialog box appears again, and the ID, Description, and Path
fields are populated.
Note: The ID is the name of the query in the Catalog. The Description may or
may not be populated, depending on whether a description was saved with the
query.
5. Click OK.
The Search Query dialog box closes.
6. At the bottom of the Physical Storage section, click the Save link.
A message appears, indicating that the family was updated successfully.
Copyright © 2017 General Electric Company. All rights reserved. • Page 49 of 280
Removing the Association Between a Simple Search Query and a Family
Copyright © 2017 General Electric Company. All rights reserved. • Page 50 of 280
Performing an Advanced Search
2. If the Advanced Search workspace appears on the Search page, proceed to step 3
of these instructions. If the Advanced Search workspace does not appear, on the
Search Type menu, click the Advanced search link.
The Advanced Search workspace appears.
Copyright © 2017 General Electric Company. All rights reserved. • Page 51 of 280
Performing an Advanced Search
3. In the Search In list, select the family of the records you want to search for. This
field is required.
After you select a family in the Search In list:
l If the family that you selected is related to one or more families, the Linked To list
will become enabled.
-or-
l If the family that you selected is not related to any other families, the Linked To
list will remain disabled, and you can proceed to step 6.
Copyright © 2017 General Electric Company. All rights reserved. • Page 52 of 280
Performing an Advanced Search
4. In the Linked To list, if desired, select a family that is related to the family you
selected in the Search In list. If you select a family in the Linked To list, the search
will return only the records that belong to the family in the Search In list that are
also linked to a record belonging to a family in the Linked To list. You will also be
able to define field conditions on the family you select in the Linked To list. This
list contains only the families that are related to the family selected in the Search
In list.
If only one relationship exists between the selected families, the Through list will
be populated automatically with that relationship, and you can proceed to step 6.
If more than one relationship exists between the selected families, the Through
list will become enabled.
Note that the Linked To list will display only families to which you have been gran-
ted View permissions in the Configuration Manager. In addition, the list will dis-
play a family only if you have been granted View permissions to the relationship
family that relates that family to the family selected in the Search In list.
For example, if you selected Pump in the Search In list, and the Pump family is
related to the Failure family through the Asset Has Failure relationship, the Linked
To list will display Failure only if you have View permissions to the Failure family
and the Asset Has Failure relationship family.
5. In the Through list, select the relationship between the families that appear in the
Search In list and the Linked To list. The search results will contain only records
that are linked using the specified relationship.
6. If desired, define field conditions.
7. Click the Find Now button.
The results appear in the search results section of the Search page. If you selected
a family in the Linked To list, the search results will display two hyperlinked record
IDs in each row. If you included one or more field conditions in your search, addi-
tional columns will appear to represent each condition that you specified. From
the results, you can open a record in either the Record Manager or the Bulk Data
Form. You can also save the search to the Catalog for future use.
Copyright © 2017 General Electric Company. All rights reserved. • Page 53 of 280
Defining Field Conditions
4. Point to the datasheet that contains the field for which you want to specify a con-
dition.
A submenu appears, displaying the name of every field that exists on the selected
datasheet, with the exception of custom forms and datasheets that do not contain
any fields. For custom forms and datasheets without fields, the submenu displays
all the fields that exist for the family. The following image shows an example of
what the submenu looks like when you point to a standard datasheet.
Copyright © 2017 General Electric Company. All rights reserved. • Page 54 of 280
Defining Field Conditions
Note: Bullets identify the fields that exist in the ID Template for the selected
family.
6. In the Condition list, select the operator to define the condition that you want to
apply to the value in the Value text box. The list of operators will change depend-
ing on the type of field you select (i.e., numeric, character, date, logical).
7. If you selected anything other than Is null, Is not null, Is true, or Is false in the
Condition list, in the Value text box, type the field value to which the specified con-
dition should be applied.
8. If you want the search to be case-sensitive, select the Match Case? check box.
Selecting the check box indicates that you want to return only the records that con-
tain the keyword you specified using the exact case that you specified in the Look
For text box.
-or-
If you do not want the search to be case-sensitive, do not select the Match Case?
check box.
Note: The Match Case? option works only on Oracle schemas. When you per-
form a search using a SQL Server data source, the search will be case-insensitive
even when the Match Case? check box is selected.
Copyright © 2017 General Electric Company. All rights reserved. • Page 55 of 280
Defining Field Conditions
10. Add additional field conditions until you have defined all the field conditions that
will cause the search to return the results that you want to see.
11. In the Match section, select one of the following options:
l All Conditions (And operator): If you select this option, the search results
will include only the records that match all of the search conditions that are
listed in the SearchConditions section.
-or-
l Any Conditions (Or operator): If you select this option, the search results will
include records that match any one of the search conditions that is listed in the
SearchConditions section.
12. Click the Find Now button.
The search results appear and contain a separate column for each field on which a
condition was defined. For example, if you define multiple conditions on the Asset
ID field and only one condition on the Asset Manufacturer field, the search results
will contain an Asset ID column and an Asset Manufacturer column.
Copyright © 2017 General Electric Company. All rights reserved. • Page 56 of 280
Operators for Numeric and Character Fields
Copyright © 2017 General Electric Company. All rights reserved. • Page 57 of 280
Operators for Date Fields
Copyright © 2017 General Electric Company. All rights reserved. • Page 58 of 280
Operators for Date Fields
Copyright © 2017 General Electric Company. All rights reserved. • Page 59 of 280
Operators for Logical Fields
Copyright © 2017 General Electric Company. All rights reserved. • Page 60 of 280
Modifying Field Conditions
Copyright © 2017 General Electric Company. All rights reserved. • Page 61 of 280
Deleting Field Conditions
Note: The condition that you remove remains populated in the Define Condi-
tions section until you remove another field condition. In other words, the
Define Conditions section always contains values from the condition that was
last removed.
The Unadded Condition dialog box appears, asking if you want to run the search
without adding the condition to the Define Conditions section.
3. Click the Yes button.
The new results appear in the search results section, and the values in the Define
Conditions section are cleared.
Copyright © 2017 General Electric Company. All rights reserved. • Page 62 of 280
Saving a Search
Saving a Search
Searches can be saved to the Catalog so that you can run them again in the future to
view updated results. You can save searches using the Save this search link and the
Save this search as link, which are located on the Common Tasks menu on the Search
page.
You will need to use the Save this search link if:
l You are saving a search for the first time.
l You are saving changes that you made to an existing search and you do not want
to change the name of the search or save it to a different location.
You will need to use the Save this search as link if:
l You have modified a previously saved search and you want to save it with a dif-
ferent name or to a different location.
You can use the following instructions for either option. As an example, we will explain
how to save a search for the first time using the Save this search link.
To save the current search:
1. In the Meridium APM Framework, on the Search page, on the Common Tasks
menu, click the Save this search link.
The Save this search dialog box appears.
Copyright © 2017 General Electric Company. All rights reserved. • Page 63 of 280
Saving a Search
Note: If you were viewing a search that already existed in the Catalog, when
you clicked the Save this search link, the Save this search dialog box would not
have appeared. The changes would have been saved automatically to the exist-
ing search.
2. Navigate to the Catalog folder in which you want to save the search.
3. In the Name text box, type a name for the search. The name is required and must
be unique to the Catalog folder in which you are saving the search.
The Caption text box is populated automatically with the value that you typed in
the Name text box.
Copyright © 2017 General Electric Company. All rights reserved. • Page 64 of 280
Saving a Search
5. If desired, type a description of the search in the Description text box. This is not
required to save the search.
6. If desired, select the Add to Home Page check box if you want to add a link to the
search to a Home Page. This is not required to save the search.
7. Click the Save button.
If you:
l Selected the Add to Home Page check box, the search is saved to the Catalog, and
the Send to Home Page - Select Home Page dialog box is displayed.
Copyright © 2017 General Electric Company. All rights reserved. • Page 65 of 280
Opening a Saved Search
Note: These instructions provide details on opening a saved search. Note that you
can also open a saved search via the Catalog.
2. Navigate to the search that you want to open, select it, and click the Open button.
Copyright © 2017 General Electric Company. All rights reserved. • Page 66 of 280
Opening a Saved Search
The saved search criteria appears. The search is not run automatically when you
open it, so initially, no results will appear in the search results section.
3. Click the Find Now button.
The results appear in the search results section.
Copyright © 2017 General Electric Company. All rights reserved. • Page 67 of 280
Deleting a Saved Search
Copyright © 2017 General Electric Company. All rights reserved. • Page 68 of 280
About Opening Records from Your Search Results
Copyright © 2017 General Electric Company. All rights reserved. • Page 69 of 280
Opening a Single Record in the Record Manager
Copyright © 2017 General Electric Company. All rights reserved. • Page 70 of 280
Opening More than One Record in the Record Manager
Note: To view another record, click the desired record in the record hierarchy.
Copyright © 2017 General Electric Company. All rights reserved. • Page 71 of 280
Opening One or More Records in the Bulk Data Form
Note: The Bulk Data Form can display multiple records only when they belong to
the same family. If you select multiple records that belong to different families, the
Open in Bulk Data Form option will not appear on the shortcut menu.
To open records in the Bulk Data Form from the search results section:
1. In the Meridium APM Framework, in the search results, press the Ctrl key (to select
multiple, non-consecutive records), or press the Shift key (to select consecutive
records), and click the rows containing the records that you want to open.
2. Right-click any of the record IDs in any of the selected rows, and then click Open
in Bulk Data Form.
The records appear in the Bulk Data Form.
Copyright © 2017 General Electric Company. All rights reserved. • Page 72 of 280
Accessing the Browser
Copyright © 2017 General Electric Company. All rights reserved. • Page 73 of 280
Aspects of the Browser
Copyright © 2017 General Electric Company. All rights reserved. • Page 74 of 280
Aspects of the Browser
In this example, you can see the Equipment family node at the root level. This node has
been expanded to reveal the Records node, which has also been expanded. Below the
Records node, you can see three individual Equipment record nodes with the Entity IDs
shown in the following image.
Below the last Equipment record node, you can see the following family nodes:
l Work History
l Functional Location
The Functional Location family node has been expanded to show a record node rep-
resenting the Functional Location record that is linked to the Equipment record rep-
resented by the last Equipment record node.
Using the Browser, you can open any specific record.
Copyright © 2017 General Electric Company. All rights reserved. • Page 75 of 280
Navigating the Browser Hierarchy
Note: System families and families flagged as Inactive in the Configuration Manager
do not appear in the Browser.
Note: When you first expand a level of the hierarchy, Meridium APM reads the data
directly from the database and caches it until you refresh that branch of the Browser.
You can continue clicking plus signs until all branches of the tree have been fully expan-
ded. You will know when a branch has been fully expanded when a minus sign appears.
To collapse a branch of the tree:
l In the Meridium APM Framework, in the Browser, click the minus sign.
Copyright © 2017 General Electric Company. All rights reserved. • Page 76 of 280
Refreshing the Browser
Copyright © 2017 General Electric Company. All rights reserved. • Page 77 of 280
Opening Records from the Browser
Copyright © 2017 General Electric Company. All rights reserved. • Page 78 of 280
About Viewing and Modifying Records
Note: These are the same tools that you will use to create and delete records.
Records store information that you can view, modify, and manipulate throughout the
Meridium APM system. Many modules provide custom interfaces that allow you to inter-
act with records in a ways that are unique to those modules. In some cases, records are
meant to be created and modified only from within the modules to which they belong.
But all records can be viewed in the Record Manger and Bulk Data Form.
Note: Depending upon the records you are using, the restrictions that have been
placed upon them by the module to which they belong, and the permissions that have
been granted to you, some of the features described in this documentation may be
unavailable.
Copyright © 2017 General Electric Company. All rights reserved. • Page 79 of 280
Introduction to the Record Manager
Copyright © 2017 General Electric Company. All rights reserved. • Page 80 of 280
Accessing the Record Manager
Copyright © 2017 General Electric Company. All rights reserved. • Page 81 of 280
Aspects of the Record Manager
Copyright © 2017 General Electric Company. All rights reserved. • Page 82 of 280
Aspects of the Record Manager Workspace
Copyright © 2017 General Electric Company. All rights reserved. • Page 83 of 280
Using the Shortcut Menu at the Top of the Record Manager Workspace
Note: The name of the Record Explorer option may be different if you are view-
ing the record hierarchy using a configured explorer.
l Associated Pages: Displays a submenu that contains the links that appear on the
Associated Pages menu. You can click the links to execute them.
l Show Explorer: Displays the Record Explorer pane. This link appears only when
the Record Explorer pane is hidden.
Note: The name of the Show Explorer option may be different if you are viewing
the record hierarchy using a configured explorer.
Copyright © 2017 General Electric Company. All rights reserved. • Page 84 of 280
Aspects of the Datasheet Area
Note: In the Bulk Data Form, the separation of tabs does not appear. Instead, all
fields are included on the same tab.
In most cases, when you open a record and view its associated datasheet in the data-
sheet area, you can adjust the height of the rows. To do so, place your cursor on a line
separating two rows, and drag the line until the rows reach the desired height. If you are
using the Record Manager, you can reset the row height to the default height by right-
clicking the first cell under the datasheet tab name and selecting Reset Row Heights.
The Reset Row Heights option is not available in the Bulk Data Form.
Copyright © 2017 General Electric Company. All rights reserved. • Page 85 of 280
Aspects of the Datasheet Area
At the top of the datasheet area, a toolbar appears and gives you access to functions
that are associated with the selected record. The toolbar contains the following icons:
Displays the Select Family dialog box, where you can choose a family for which to
create a new record.
Saves the current record, including any modifications that you have made.
Saves the current record and displays a blank datasheet that you can use to create
a new record. The new record will automatically be created using the family of the
current record.
Deletes the current record after asking for confirmation.
Displays a new datasheet, into which all the information except the Record ID
from the current record has been copied. You can use the datasheet to create a
new record based on the current record.
Displays the Preview window, from which you can print the information asso-
ciated with the current record.
Displays the Reference Documents window, where you can view, edit, and create
reference documents for the current record.
Note: When you are viewing the datasheet area in the Record Manager, if the
current record is already linked to a Reference Document record, the icon
will be replaced with the icon.
Note: All of these icons appear in the Record Manager. Only the and buttons,
however, are available in the Bulk Data Form.
The Datasheet list appears to the left of the toolbar and contains the list of datasheets
that have been configured for the family to which the selected record belongs. If
desired, you can view a datasheet other than the one that is currently displayed by select-
ing the desired datasheet from the list.
Copyright © 2017 General Electric Company. All rights reserved. • Page 86 of 280
Aspects of the Datasheet Area
In addition, if State Configuration has been defined for the family of the selected record,
the current record state will be displayed along with an Operations link, which you can
click to display a list of the available operations for the current record. From this list,
you can select an operation, which will cause the record's state to change.
Note that in most of our instructions, we refer to Common Tasks links in step-by-step
instructions. Keep in mind, however, that you can use the icons on the datasheet tool-
bar to perform some of the same tasks.
Copyright © 2017 General Electric Company. All rights reserved. • Page 87 of 280
Interacting with Fields on Datasheets
Copyright © 2017 General Electric Company. All rights reserved. • Page 88 of 280
Interacting with Fields on Datasheets
appear in the multi-value field, they are separated by commas. The number of val-
ues allowed in a multi-value field is determined by an administrative user.
l Custom Data Editor fields: Fields that provide access to a custom data editor.
These types of fields contain a button to the right of the cell. When you click
this button, a custom data editor will appear. The content and behavior of the
editor varies from one field to another and is described in detail in the appro-
priate module documentation. For example, the Production Event Code field on
the Production Event datasheet in PLA provides access to a custom data editor
that is described in detail in the PLA documentation.
You can copy and paste a value from one field to another field by right-clicking inside
the cell and then using the options on the shortcut menu (or standard keyboard short-
cuts). When you are copying and pasting values from one field to another, you should
keep in mind the following guidelines:
l You can copy the entire value from any field except a logical field (i.e., a check
box), regardless of whether it is enabled or disabled.
l You can copy portions of a value only from a text, character, or custom data editor
field that is enabled.
l You can paste a value into only text, character, or custom data editor fields that
are enabled.
Each field may have a rule defined for it that controls how the field behaves and how the
data in that field is displayed. For example, a rule may be defined for a numeric field
that automatically causes the value in the field to be formatted as currency. Another
field might have a rule that causes various validation checks to be performed or that lim-
its the values that you can type in the field. Yet another rule may cause values entered in
one field to determine values that appear in another field, either within a single record
or across records, as is the case with reference tables. A text field might have a rule that
determines how many lines of text will appear in that field. Rules are configurable and
will vary from one Meridium APM implementation to the next.
If you create a record for a family that has field-level rules defined, you may not see the
result of these rules until after you save the record and then open it again.
When you are viewing a record for a family that has field-level rules defined, the values
that you see on a datasheet are the formatted values, which may or may not be the
same value that is stored in the database. For example, suppose the field Amount has a
rule configured, such that a dollar sign will be displayed by default next to the value that
you type in that field. When you type a value in the Amount field, that value is saved to
the database, but when you view the record, a dollar sign will appear next to the value
that you entered in the record.
Copyright © 2017 General Electric Company. All rights reserved. • Page 89 of 280
Navigating Fields in Datasheets
Copyright © 2017 General Electric Company. All rights reserved. • Page 90 of 280
About the Calendar Feature
Above the monthly grid, the year appears. You can click a month in the grid to dis-
play the daily calendar for that month. Or, you can click the left and right arrows
next to the year to view the monthly grid for a different year.
Copyright © 2017 General Electric Company. All rights reserved. • Page 91 of 280
About the Calendar Feature
After you are viewing the monthly grid, when you click the year link, a yearly grid
appears in place of the twelve month grid, displaying years in a ten-year time
span, as shown in the following image.
Above the yearly grid, the ten-year time span appears. You can click a year in the
grid to display the twelve-month grid for that year. Or, you can click the left and
right arrows next to view the ten years in a different ten-year time.
l Calendar: Lets you select the desired date.
l Clear button: Lets you clear the selected date and time from the Calendar feature.
Note the following about the Clear button:
n In a custom layout datasheet, the Clear button removes the date and time
from the field from which you accessed the Calendar feature.
n In a standard datasheet, the Clear button does not remove the date and
time from the field. Instead, the following date and time is displayed in the
field from which you accessed the Calendar feature: 1/1/0001 12:00 AM.
l OK button: Closes the Calendar feature and displays the selected date and time in
the field from which you accessed the Calendar feature.
l Cancel button: Closes the Calendar feature and discards your selection.
l Clock: Shows the time that you select in the time text box as it appears on a clock.
l Time text box: Lets you select the desired time and specify A.M. or P.M. The
default value in this text box is 12:00:00 AM. You can modify this value by clicking
the up and down arrows that appear in the text box.
Copyright © 2017 General Electric Company. All rights reserved. • Page 92 of 280
Selecting a Date and Time Using the Calendar Feature
Note: If you type a date in a date field, when you type the first value in the field, the
remaining values for the date are completed automatically using the current date. You
can continue typing over these values to replace them with your own. For example, if
today's date is 7/21/2009 and you begin typing 5 in the date field, the date will appear
as 5/21/2009 until you modify the remaining values.
Copyright © 2017 General Electric Company. All rights reserved. • Page 93 of 280
About the Text Editor
Copyright © 2017 General Electric Company. All rights reserved. • Page 94 of 280
Using the Text Editor
ŒHint: You can also press the F4 key on your keyboard to access the text editor.
2. Type the desired text in the text box.
Note: If you want to search the text for misspelled words, you can click the
Spelling button to access the Spell Check feature.
3. Click OK.
The text editor closes and the text that you typed appears in the field from which
you accessed the text editor.
Copyright © 2017 General Electric Company. All rights reserved. • Page 95 of 280
About the UOM Converter Tool
Copyright © 2017 General Electric Company. All rights reserved. • Page 96 of 280
Viewing a Stored Value in a Different UOM
3. On the View tab, in the list on the far right, choose the desired UOM.
Note: The list contains the UOMs for which conversions have been defined for
the current UOM in the Configuration Manager. For example, if the current UOM
is pounds, the list will contain all the UOMs to which pounds can be converted,
as determined by the UOM conversion table in the Configuration Manager.
The Original Value field displays the current value in the datasheet field. The Con-
verted Value field displays what the value would be if you were to apply the selec-
ted conversion.
4. Click OK to close the Unit of Measure Converter Tool.
Copyright © 2017 General Electric Company. All rights reserved. • Page 97 of 280
Converting a Supplied UOM to a Datsheet UOM
Copyright © 2017 General Electric Company. All rights reserved. • Page 98 of 280
Converting a Supplied UOM to a Datsheet UOM
Copyright © 2017 General Electric Company. All rights reserved. • Page 99 of 280
Opening Records in a Master/Detail Datasheet
Copyright © 2017 General Electric Company. All rights reserved. • Page 100 of 280
Working with Master/Detail Datasheets
Copyright © 2017 General Electric Company. All rights reserved. • Page 101 of 280
Working with Master/Detail Datasheets
features that are not available in standard datasheets. Specifically, you can perform the
following tasks using a master/detail datasheet:
l To create a new detail record, click inside the first blank grid row. The row
selector will display an image of a pencil, indicating that you can type information
into the grid row.
l To edit an existing detail record, click the row containing the record, and modify
the values in the fields as desired.
l To link the master record to another existing detail record, click the button
at the top of the detail grid, and then search for the desired record using a search.
Select the record(s) that you want to link to the master record, and click the Link
button.
Note: After you select a detail record to link to the master record, that detail
record becomes unavailable in the search results if you select to link another
detail record to the master record. For example, if you link Detail Record 1 to
Master Record A and then choose to link another detail record to Master Record
A, Detail Record 1 will not appear in the search results.
l To unlink a detail record from the master record, select the record that you want
to unlink, and click the button. On the confirmation message that appears,
click the Yes button to confirm the deletion.
l To save all the detail records, click the button at the top of the master/detail
datasheet.
Note: When you save the detail records, if any records cannot be saved, the
Error Reportwindow appears, which displays a list of records that could not be
saved along with a description of why the failure occurred.
l To delete an existing detail record, select the row containing the record you want
to delete, and click the Delete button above the detail grid or press the Delete key
on your keyboard. The record is deleted, as is the link between it and the master
record.
l To print the master record as an individual record, click the Print button on the
Record Manager toolbar. An administrative user can create a custom report to
allow you to print both the master and detail records on the same report.
Copyright © 2017 General Electric Company. All rights reserved. • Page 102 of 280
Using the Shortcut Menu in Custom-Layout Datasheets
Copyright © 2017 General Electric Company. All rights reserved. • Page 103 of 280
Overview of the Record Hierarchy
Copyright © 2017 General Electric Company. All rights reserved. • Page 104 of 280
Overview of the Record Hierarchy
In the following topics, we describe the record hierarchy and the features that are
provided in the standard Record Explorer pane. Note that these features may be slightly
different if you are viewing a record in a pane whose contents are determined based on
a configured explorer.
Copyright © 2017 General Electric Company. All rights reserved. • Page 105 of 280
Aspects of the Record Hierarchy
(Family Icon): Designates a family that is related to the root record's family.
(Record Icon): Designates a record that is linked to the root record.
A plus sign (+) to the left of a family icon indicates that one or more records belonging
to that family are linked to the root record. The absence of a plus sign means that no
linked records exist for that family. You can expand the family to view additional related
families and linked records by clicking the plus sign or by double-clicking the family
name. A minus sign (-) indicates that a family is fully expanded.
When you reach the record level, you can double-click any record name to view the
record contents in the Record Manager workspace.
By default, the record hierarchy is filtered to display only the families that contain a
record that is linked to the root record. For example, if the root record belongs to the
Centrifugal Pump family, and the Centrifugal Pump family is related to the Failure fam-
ily, the Failure family would appear in the record hierarchy by default only if one or
more Failure records were linked to the root Centrifugal Pump record.
The text at the bottom of the Record Explorer pane indicates the current filtering option
that is applied to the record hierarchy. The record hierarchy can be filtered to display:
l Only families that contain records that are linked to the root record. If the record
hierarchy is showing these families, the text below the Record Explorer pane is
Related Families Displayed.
-or-
l ALL families that are related to the family of the root record, regardless of
whether those families contain records that are linked to the root record. If the
record hierarchy is showing these families, the text below the Record Explorer
pane is All Families Displayed.
If desired, you can change the filtering option.
The following figure shows only the families that contain one or more records that are
linked to root Unit record.
Copyright © 2017 General Electric Company. All rights reserved. • Page 106 of 280
Aspects of the Record Hierarchy
The next figure, on the other hand, shows all the families that are related to the Unit
family.
Copyright © 2017 General Electric Company. All rights reserved. • Page 107 of 280
Aspects of the Record Hierarchy
Each branch in the tree will display up to 1,000 related records at a time. If a family or
record is linked to more than 1,000 records, a More node will appear at the bottom of
the list. You can expand the node to view additional records.
Copyright © 2017 General Electric Company. All rights reserved. • Page 108 of 280
Shortcut Menu in the Record Hierarchy
The menu options that appear will also vary depending on the pane that is used to dis-
play the record hierarchy (i.e., Record Explorer pane or a configured explorer).
Depending on the node you select and the current conditions that exist, the menu may
display any of the following options:
l Expand/Collapse <Record>'s Children: Expands or collapses the selected node to
display its children. This menu reads Expand when you select an un-expanded
node; it reads Collapse when you select an expanded node. This menu item is
enabled only when you select a node that has one or more children.
l Create a new <Family record> to link to <root record>: Displays the Insert New
dialog box, where you can create a new record and link it to the root record. This
menu item appears only when you select a family node of a familywhoseFamily is
Managed by Product Modulecheck box isclearedin the Configuration Manager.If
the root record can be linked to only one record in the selected family, this link is
enabled only if the root record has not yet been linked to a record in the selected
family.
l Find an existing <selected family record> to link to <root record>: Displays the
Find an existing <Family record> to link to the <root record> window, where you
can search for an existing record to link to the root record.
l Create new <selected family record> related to record <root record>: Opens the
Bulk Data Form, where you can create multiple records to link to the root record.
This link is enabled only if the root record can be linked to more than one record
in the selected family.
l Manage all <selected family> records related to the <root record>: Opens the
Bulk Data Form, which displays all the records in the currently selected family that
are linked to the root record. If the root record and the selected family are related
through more than one relationship, the Select Link Family dialog box will
appear, where you can select the desired link family. This menu item is enabled
only if the following conditions have been met:
Copyright © 2017 General Electric Company. All rights reserved. • Page 109 of 280
Shortcut Menu in the Record Hierarchy
n You have permissions to create, edit, and delete records using the Bulk Data
Form.
n The root record can be linked to more than one record in the selected fam-
ily.
n You select a family node of a family whose Family is Managed by Product
Module check box is cleared in the Configuration Manager.
Note: If no records have been linked to the root record through the selected fam-
ily, the Manage option instead reads Create new <selected family> records
related to <root record>, which will open a blank Bulk Data Form so that you
create multiple records to link to the root record.
l Make <Record> the root record: Adjusts the display of the hierarchy to make the
currently selected record the root record. This menu item appears only when you
select a record node.
l Unlink <Record> from <root record>: Unlinks the currently selected record from
the root record. This menu item appears only when you select a record node.
Also, this menu item is enabled only if:
l You have Delete permissions to the relationship family that relates the fam-
ily of the selected record to the family of the root record.
-and-
l The Family is Managed by Product Module check box (in the Configuration
Manager) is cleared for the family of the root record.
l Move link from <Current Record> to another <Record in the same family>: Dis-
plays the Find an existing <Family record> to link to the <root record> window,
which you can use to find another record of the same family as the root record
and move the currently selected record link to that record. This menu item is
enabled only if:
l You have Delete and Insert permissions to the relationship family that
relates the family of the selected record to the family of the root record.
-and-
l The Family is Managed by Product Module check box (in the Configuration
Manager) is cleared for the family of the selected record.
l View link fields: Lets you view the link fields associated with the current record.
l Send <Record> to: Displays a submenu with three options that you can use to
send a link to the current recordto one of three destinations.
l Open <Record> in a new window: Opens the current record in a new instance of
the Meridium APM Framework application.
l Refresh: Loads the most current records in the family you selected when you
accessed the shortcut menu. For example, if you right-clicked the Piping Circuit
family and then clicked Refresh, the most current records in the Piping Circuit fam-
ily would be loaded into the tree. If you right-click the root record and click
Refresh, the most current records in all sub-families of the root record's family
Copyright © 2017 General Electric Company. All rights reserved. • Page 110 of 280
Shortcut Menu in the Record Hierarchy
will be loaded into the tree. Note, however, that selecting Refresh from the root
record node automatically collapses all family nodes. You can then click the plus
sign next to a family node to expand it.
Copyright © 2017 General Electric Company. All rights reserved. • Page 111 of 280
Changing the Filtering Option
Copyright © 2017 General Electric Company. All rights reserved. • Page 112 of 280
Changing the Location of the Record Hierarchy
Note: The position of the record hierarchy is not saved after you navigate away
from the page.
Copyright © 2017 General Electric Company. All rights reserved. • Page 113 of 280
Hiding and Displaying the Record Hierarchy
l In the Meridium APM Framework, in the Record manager, click the button to
the left of the header in the Record Manager workspace, and on the submenu,
point to Record Explorer pane, and then click Hide.
-or-
l Click the X in the upper right corner of the Record Explorer pane.
The Record Explorer pane disappears.
To display the Record Explorer pane:
l In the Meridium APM Framework, in the Record Manager, click the button to
the left of the header in the Record Manager workspace, and on the submenu,
click Show Record Explorer.
The Record Explorer pane appears.
Copyright © 2017 General Electric Company. All rights reserved. • Page 114 of 280
Making a Linked Record the Root Record
Copyright © 2017 General Electric Company. All rights reserved. • Page 115 of 280
Overview of Configured Explorers
A configured explorer, on the other hand, lets you specify exactly which related families
you want to see in the record hierarchy, the order in which you want to see them, and
the options that you want to make available on the shortcut menu when you right-click
an item. The baseline configured explorer that is provided for the General Inspection
family specifies that four families should be displayed in the following order: General
Finding, Inspection Recommendation, Pressure Test Sub-Inspection, and Reference
Document.
In the following image, you can see a General Inspection record displayed in a record
hierarchy whose contents are driven by this configured explorer. Notice that the pane is
Copyright © 2017 General Electric Company. All rights reserved. • Page 116 of 280
Overview of Configured Explorers
titled General Inspection Document Explorer, which is the name of the configured
explorer as it was saved to the Catalog.
Copyright © 2017 General Electric Company. All rights reserved. • Page 117 of 280
About Mapping Fields in Configured Explorers
Copyright © 2017 General Electric Company. All rights reserved. • Page 118 of 280
An Example of Mapping Fields Using Configured Explorers
Copyright © 2017 General Electric Company. All rights reserved. • Page 119 of 280
An Example of Mapping Fields Using Configured Explorers
Copyright © 2017 General Electric Company. All rights reserved. • Page 120 of 280
Creating a Configured Explorer
Note: After you create a configured explorer, you can construct URLs to display the
record hierarchy in a pane whose contents are based on the configured explorer
instead of the standard Record Explorer pane.
Copyright © 2017 General Electric Company. All rights reserved. • Page 121 of 280
Creating a Configured Explorer
Copyright © 2017 General Electric Company. All rights reserved. • Page 122 of 280
Creating a Configured Explorer
A record hierarchy that is not expanded would look similar to the following image:
5. When this configured explorer is used to display records in the record hierarchy, if
you want to allow users to switch between the record hierarchy that is built using
this configured explorer and the record hierarchy that is displayed in the standard
Record Explorer pane, select the Allow user to switch explorer check box.
6. Click the Next button.
The Select Relationship Families screen appears, displaying a list of the rela-
tionships in which the selected family participates.
Copyright © 2017 General Electric Company. All rights reserved. • Page 123 of 280
Creating a Configured Explorer
The families are displayed in alphabetical order. If desired, you can use this screen
to limit the number of relationships that will appear in the record hierarchy when
this configured explorer is used to display records. This screen also contains an
option to show the filter options below the record hierarchy, which lets users dis-
play all families related to the root family (even if no records exist in that family)
or only families that are related that also contain records.
7. Select the Show Filter Options check box if you want users to be able to switch
between displaying all families related to the root family or only those families
that are related that also have existing records.
For an example, if you selected the Allow user to switch explorer check box on
the previous screen and the Show Filter Options check box on this screen, users
will see something like this:
If you did not select the Allow user to switch explorer check box on the previous
screen and you DID select the Show Filter Options check box on this screen, users
will see something like this:
Copyright © 2017 General Electric Company. All rights reserved. • Page 124 of 280
Creating a Configured Explorer
8. On the Select Relationship Families screen, select the check boxes that cor-
respond to the relationship families that you want to appear in the record hier-
archy when this configured explorer is used to display records. You can display
relationships in which the subfamilies of the root family participate.
For example, suppose the root family is Piping, the subfamily is Thickness Meas-
urement Location, and the subfamilies are TML Corrosion AnalysisandCorrosion
Analysis Settings. If you want to show records in all four families in the record hier-
archy, you must select the relationships in which those families participate. In this
example, the relationships are:
l Has Datapoints, where Piping is the predecessor and Thickness Measurement
Location is the successor.
l Has Corrosion Analysis, where Thickness Measurement Location is the pre-
decessor and TML Corrosion Analysis is the successor.
l Has Corrosion Analysis Settings, where Thickness Measurement Location is the
predecessor and Corrosion Analysis Settings is the successor.
9. Click the Next button.
The Specify Field Mappings screen appears.
10. If you do not want to specify field mappings, skip to step 18 of these instructions.
-or-
If you want to define field mappings, select the Specify Field Mappings check box.
When you do so, a grid appears at the bottom of the screen.
Copyright © 2017 General Electric Company. All rights reserved. • Page 125 of 280
Creating a Configured Explorer
12. In the Pick a source family list, select the source family for the mapping. The fam-
ilies that appear in this list, are the families that you selected on the Select Root
Families screen.
13. In the Pick a source field from the source family list, select the desired source
field.
14. In the Pick a destination family list, select the desired destination family.
15. In the Pick a destination field from the destination family list, select the des-
tination field.
16. Click the Add mapping button.
The Specify Field Mappings screen appears again. Your new mapping appears in
the list.
17. On the Specify Field Mappings screen, continue configuring the list of mappings.
Click the Create new mapping link to create another mapping. If you need to
delete a mapping, select it in the list, and then click the Delete selected mapping
link.
The order the fields are displayed represents the order in which the fields will be
mapped. You can change the order using the arrow buttons.
Copyright © 2017 General Electric Company. All rights reserved. • Page 126 of 280
Creating a Configured Explorer
automatically. You must manually change the value in the subfamily record. If
you want to maintain synchronization of family to subfamily values auto-
matically, you must implement custom rules on a case-by-case basis.
18. On the Specify Field Mappings screen, click the Next button.
The Specify Family Sorting screen appears.
19. If you do not want to specify family sorting, skip to step 22 of these instructions.
Note that if you do not specify family sorting, the families will appear in the record
hierarchy in alphabetical order.
-or-
If you want to define family sorting, select the Specify Family Sorting check box.
When you do so, a tree appears, displaying the root family and any families that
you selected on the Select Relationship Families screen.
20. To apply a sorting order to the families that will appear in the record hierarchy
when this configured explorer is used to display records, in the tree, sort the fam-
ilies by clicking a family and using the up or down arrow to move it up or down in
the list. The families will appear in the record hierarchy in the order that you spe-
cify.
21. To apply a sorting order to the records that will appear in the record hierarchy in
Copyright © 2017 General Electric Company. All rights reserved. • Page 127 of 280
Creating a Configured Explorer
Copyright © 2017 General Electric Company. All rights reserved. • Page 128 of 280
Creating a Configured Explorer
You can configure the shortcut menu that appears when you right-click each fam-
ily node and record node in the record hierarchy. Family and record nodes appear
on the left side of the window, and the menu options appear on the right side of
the window. Family nodes are designated by the symbol, and record nodes are
designated by the symbol.
When you select a family or record node on the left, the menu options on the
right change based upon the options that are logical for that node. For example, if
you select a family node, the option Send record to does not apply, so it does not
appear on the right.
In addition to the options that appear on the shortcut menu in the standard
Record Explorer pane, the list on the right will also include any links defined on
the Associated Pages menu and submenus that are defined in the URL Manager
for the family selected on the left. For example, if you select Thickness Meas-
urement Entity on the left, the options on the right are the links defined on the
Associated Pages menu and submenus defined for the Thickness Measurement
family.
23. Select the node for which you want to configure the shortcut menu, and use the
right side of the window to configure the shortcut menu for that node. On the
right side of the window, you can:
l Clear the check box for each menu option that you do not want to include.
l Use the up and down arrows to move the options up or down in the shortcut
menu.
Copyright © 2017 General Electric Company. All rights reserved. • Page 129 of 280
Creating a Configured Explorer
Note that the dash (-) option represents a menu separator. For example, if you
menu is configured like this:
24. Continue configuring the shortcut menu for each node as desired, and click the
Finish button when you are finished.
The Save As dialog box appears.
Copyright © 2017 General Electric Company. All rights reserved. • Page 130 of 280
Creating a Configured Explorer
25. In the Name text box, type a name for the configured explorer. The name is
required and must be unique to the Catalog folder in which you are saving the con-
figured explorer.
The Caption text box is populated automatically with the value that you typed in
the Name text box.
26. If desired, click the button to manage translations for that string.
27. If desired, type a description of the configured explorer in the Description text
box. This is not required to save the configured explorer.
Copyright © 2017 General Electric Company. All rights reserved. • Page 131 of 280
Creating a Configured Explorer
28. If desired, select the Add to Home Page check box if you want to add a link to the
configured explorer to a Home Page. This is not required to save the configured
explorer.
29. Click the Save button.
If you:
l Selected the Add to Home Page check box, the configured explorer is saved to the
Catalog, and the Send to Home Page - Select Home Page dialog box is displayed.
Copyright © 2017 General Electric Company. All rights reserved. • Page 132 of 280
About Opening a Record in a Configured Explorer
Copyright © 2017 General Electric Company. All rights reserved. • Page 133 of 280
Opening a Record in a Configured Explorer
Copyright © 2017 General Electric Company. All rights reserved. • Page 134 of 280
Creating Records in a Configured Explorer
Copyright © 2017 General Electric Company. All rights reserved. • Page 135 of 280
Modifying a Configured Explorer
4. Expand the hierarchy until you find the family for which the configured explorer is
configured. The families are displayed in alphabetical order. When you have found
the desired family, select the corresponding check box. Note the following:
l If you select only one family, you will be able to use this configured explorer
to display records in that family only. If as the root family of the record hier-
archy. If you select multiple families, you will be able to use this configured
explorer to display a record in any of the selected families as the root family
of the record hierarchy.
l If you select a family, you will be able to use this configured explorer to dis-
play records in any subfamily as the root family of the record hierarchy.
l If you select a subfamily, the name of that family and any parent family is
colored in blue.
5. When this configured explorer is used to display records in the record hierarchy, if
you want to modify the configured explorer for the currently selected family (i.e., if
you do not want to modify the root family), accept the existing selection.
-or-
Copyright © 2017 General Electric Company. All rights reserved. • Page 136 of 280
Modifying a Configured Explorer
If you want to modify the family for which the configured explorer is configured,
clear the selected check box, and select the desired check box.
6. If you want to expand the families that are displayed in the record hierarchy in the
configured explorer to show any records in those families, select the Auto expand
root families in defined explorer check box if it is not already selected.
For example, an expanded Configured Explorer would look similar to the fol-
lowing image:
A Configured Explorer that is not expanded would look similar to the following
image:
7. If you want to allow users to switch between the record hierarchy that is built
using this configured explorer and the record hierarchy that is displayed in the
standard Record Explorer pane, select the Allow user to switch explorer check
box.
8. Click the Next button.
The Select Relationship Families screen appears, displaying a list of the rela-
tionships in which the selected family participates. The families are displayed in
alphabetical order. If desired, you can use this screen to limit the number of rela-
tionships that will appear in the record hierarchy when this configured explorer is
used to display records. This screen also contains an option to show the filter
options below the record hierarchy, which lets users display all families related to
the root family (even if no records exist in that family) or only families that are
related that also contain records.
Copyright © 2017 General Electric Company. All rights reserved. • Page 137 of 280
Modifying a Configured Explorer
9. Select the Show Filter Options check box if you want users to be able to switch
between displaying all families related to the root family or only those families
that are related that also have existing records.
For an example, if you selected the Allow user to switch explorer check box
on the previous screen and theShow Filter Options check box on this
screen, users will see something like this:
If you did not select the Allow user to switch explorer check box on the pre-
vious screen and you DID select the Show Filter Optionscheck box on this
screen, users will see something like this:
10. On the Select Relationship Families screen, select the check boxes that cor-
respond to the relationship families that you want to appear in the record hier-
archy when this configured explorer is used to display records. You can display
relationships in which the subfamilies of the root family participate.
For example, if the root family is Piping, the subfamily is Thickness Measurement
Location, and the grandchild families are TML Corrosion Analysis and Corrosion
Analysis Settings. If you want to show records in all four families in the configured
explorer, you must select the relationships in which those families participate. In
this example, the relationships are:
l Has Datapoints, where Piping is the predecessor and Thickness Meas-
urement Location is the successor.
l Has Corrosion Analysis, where Thickness Measurement Location is the pre-
decessor and TML Corrosion Analysis is the successor.
l Has Corrosion Analysis Settings, where Thickness Measurement Location is
the predecessor and Corrosion Analysis Settings is the successor.
11. Click the Next button.
The Specify Field Mappings screen appears.
12. If you do not want to specify field mappings, skip to Step 20 of these instructions.
-or-
If you want to define field mappings, select the Specify Field Mappings check box.
When you do so, a list appears at the bottom of the screen.
Copyright © 2017 General Electric Company. All rights reserved. • Page 138 of 280
Modifying a Configured Explorer
Note: If a field in a family has been mapped to a field in a subfamily, when you
create a new record in the subfamily, it will automatically inherit the value for
that field in the family record. If, however, you later change the field value in the
family record, the field value in the subfamily record will not be updated auto-
matically. You must manually change the value in the subfamily record. If you
want to maintain synchronization of family to subfamily values automatically,
you must implement custom rules on a case-by-case basis.
Copyright © 2017 General Electric Company. All rights reserved. • Page 139 of 280
Modifying a Configured Explorer
20. On the Specify Field Mappings screen, click the Next button.
The Specify Family Sorting screen appears.
21. If you do not want to specify family sorting, skip to step 24 of these instructions.
Note that if you do not specify family sorting, the families will appear in the record
hierarchy in alphabetical order.
-or-
If you want to define family sorting, select the Specify Family Sorting check box.
When you do so, a tree appears, displaying the root family and any families that
you selected on the Select Relationship Families screen.
22. To apply a sorting order to the families that will appear in the record hierarchy
when this configured explorer is used to display records, in the tree, sort the fam-
ilies by clicking a family and using the arrow buttons to move it up or down in the
list. The families will appear in the record hierarchy in the order that you specify.
23. To apply a sorting order to the records that will appear in the record hierarchy in
your configured explorer:
a. In the tree, select a family.
The following options appear at the bottom of the window:
l Sort records in ascending order: Causes the records in the selected family to
appear in ascending order, according to their record IDs.
l Sort records in descending order: Causes the records in the selected family to
appear in descending order, according to their record IDs.
l Sort records by record ID: Causes the records in the selected family to be sorted
by Record ID.
l Sort records by field: Causes the records in the selected family to be sorted by
field. When this option is selected, a drop down list appears, displaying the fields
for the selected family.
b. Select the desired sorting options. Note that the sorting options that you select in
each group of options will be applied to the records.
For example, if you select the Failure family and choose the Sort records in
ascending order option and the Sort records by record ID option, Failure
records would appear in the record hierarchy in ascending order according to
their record IDs.
24. Click the Next button.
The Configure Shortcut Menus screen appears, displaying the sorting specified on
the previous Specify Family Sorting screen.
You can configure the shortcut menu that appears when you right-click each fam-
ily node and record node in the Configured Explorer. Family and record nodes
Copyright © 2017 General Electric Company. All rights reserved. • Page 140 of 280
Modifying a Configured Explorer
appear on the left side of the window, and the menu options appear on the right
side of the window. Family nodes are designated by the symbol, and record
nodes are designated by the symbol.
When you select a family or record node on the left, the menu options on the
right change based upon the options that are logical for that node. For example, if
you select a family node, the option Send record to does not apply, so it does not
appear on the right.
In addition to the options that appear on the shortcut menu in the standard
Record Explorer pane, the list on the right will also include any links defined on
the Associated Pages menu and submenus that are defined in the URL Manager
for the family selected on the left. For example, if you select Thickness Meas-
urement Entity on the left, the options on the right are the links defined on the
Associated Pages menu and submenus defined for the Thickness Measurement
family.
25. Select the node for which you want to configure the shortcut menu, and use the
right side of the window to configure the shortcut menu for that node. On the
right side of the window, you can:
l Clear the check box for each menu option that you do not want to include.
l Use the up and down arrows to move the options up or down in the shortcut
menu.
Note that the dash (-) option represents a menu separator.
For example, if the menu is configured like this:
Copyright © 2017 General Electric Company. All rights reserved. • Page 141 of 280
Modifying a Configured Explorer
26. Continue configuring the shortcut menu for each node as desired, and click the
Finish button when you are finished.
Your changes to the configured explorer are saved.
Copyright © 2017 General Electric Company. All rights reserved. • Page 142 of 280
About Associating Families With Configured Explorers
Copyright © 2017 General Electric Company. All rights reserved. • Page 143 of 280
Associating a Family With a Configured Explorer
Note: The ID is the name of the configured explorer in the Catalog. The
Description may or may not be populated, depending on whether a description
was saved with the configured explorer.
5. Click OK.
The Configured Explorer dialog box closes.
6. At the bottom of the Physical Storage section, click the Save link.
A message appears, indicating that the family was updated successfully.
Copyright © 2017 General Electric Company. All rights reserved. • Page 144 of 280
Removing the Association Between a Configured Explorer and a Family
Copyright © 2017 General Electric Company. All rights reserved. • Page 145 of 280
Common Tasks Menu
The Common Tasks menu on the Record Manager page contains the following links:
l New: Displays the Select Family dialog box, where you can choose a family for
which to create a new record.
l Save: Saves the current record, including any modifications that you have made.
l Save and New: Saves the current record and displays a blank datasheet that you
can use to create a new record. The new record will automatically be added to the
family of the current record.
l Delete: Deletes the current record after asking for confirmation.
l Copy: Displays a new datasheet, into which all the information except the Record
ID from the current record has been copied. You can use the datasheet to create a
new record based on the current record.
l Print: Displays the Preview window, from which you can .
l Documents: Displays the Reference Documents window, where you can view,
edit, and add reference documents for the current record.
l Send To: Displays a submenu with options that let you .
Note: When you use the Send To feature in the Record Manager, the Data-
sheet ID is included in the URL that is generated. In this way, when you access
the record using the link, the Record Manager will default to the datasheet that
was displayed at the time the link was sent.
l Help: Display the context-sensitive Help topic for the Record Manager.
Copyright © 2017 General Electric Company. All rights reserved. • Page 146 of 280
Associated Pages Menu
Copyright © 2017 General Electric Company. All rights reserved. • Page 147 of 280
About Revision History
From this example, you can see that revision history has been enabled on the Asset
Installation Date field and the Asset Status field. Note that revision history may be
enabled on other fields, but if at least two values have not been saved in those fields,
you will not see them in the Field Change History dialog box.
You can also see from the example that the first value entered in the Asset installation
Date field was 5/18/2010 at 9:08 A.M. This value was changed to 5/19/2010 at 9:08 A.M.
on May 18, 2010.
Additionally, you can see that the first value entered in the Asset Status field was
Inactive. This value was changed to Active at 9:08 A.M. on May 18, 2010.
Note: The time recorded with the change is the time that the record was saved.
Note also that the Field Change History dialog box displays the revision history for all
fields for which revision history was once enabled, regardless of whether the revision
history is currently enabled in the Configuration Manager. This means that if revision his-
tory is enabled for the Asset Installation Date field and the Asset Status field on May 18,
2010, you can change the Asset Installation Date and Asset Status values as many times
Copyright © 2017 General Electric Company. All rights reserved. • Page 148 of 280
About Revision History
as necessary and see those changes reflected in the Field Change History dialog box. If,
however, revision history is disabled for the Asset Installation Date field on May 20,
2010, you will still see the Asset Installation Date field in the Field Change History dialog
box, but you will see only the changes that were made up to May 20, 2010. Any changes
made after May 20, 2010, will not appear in the Field Change History dialog box.
Note that in order for a value to appear in the Field Change History dialog box, the
record must have been saved with the value.
Copyright © 2017 General Electric Company. All rights reserved. • Page 149 of 280
Accessing the Field Change History Dialog Box
Note: If the revision history feature has not been enabled in the Configuration
Manager for any fields, a message will appear, indicating that no revision history
is available.
3. When you are finished viewing the revision history, click the Close button to close
the dialog box.
Copyright © 2017 General Electric Company. All rights reserved. • Page 150 of 280
About Linking Records
Copyright © 2017 General Electric Company. All rights reserved. • Page 151 of 280
Linking Two Existing Records
ager relating the selected family to the family of the root record, the Select
Link Family dialog box appears.
a. On the Select Link Family dialog box, select the check box for the rela-
Thefamily
tionship Find an
youexisting
want to<Family record>
use to link to link to the <root record> win-
the records.
dow appears. Notice that the family you selected appears by default in
b. Click the
theSelect
Searchlink family button.
In field.
-or-
l If only one relationship has been set up in the Configuration Manager for
the associated families, the Find an existing <Family record> to link to the
<root record> window appears, displaying the selected family in the Search
In field.
4. On the Find an existing <Family record> to link to the <root record>window, in
the Look For text box, type a keyword that will find the record that you want to
link to the root record.
5. Click the Find Now button.
Your search results appear in a list below the search form.
6. Select the desired record, and click the Link to Selected Record button, which
appears at the bottom of the page.
The Find an existing <Family record> to link to the <root record> window closes,
revealing the Record Manager. The record you selected from the search results is
linked to the root record.
Copyright © 2017 General Electric Company. All rights reserved. • Page 152 of 280
Linking an Existing Record to a New Record
Copyright © 2017 General Electric Company. All rights reserved. • Page 153 of 280
Moving Links Between Records
The Find an existing <Family record> to link to the <root record> window closes,
revealing the Record Manager, where the link has been removed from the root
record. You can do a search to see that the link has been moved to the record that
you selected.
Copyright © 2017 General Electric Company. All rights reserved. • Page 154 of 280
Unlinking Records
Unlinking Records
If desired, you can unlink two records after opening either of the two records in the
Record Manager.
To unlink records:
1. In the Meridium APM Framework, in the Record Manager, open the desired
record.
2. In the Record Explorerpane, right-click the record to which the root record is
linked, and click Unlink <record> from <root record>.
l If only one relationship has been set up in the Configuration Manager for
the associated families, a confirmation message appears, asking if you really
want to remove the link. In this case, skip to step 6 of these instructions.
-or-
l If more than one relationship has been defined in the Configuration Manager relat-
ing the selected entity family to the family of the root record, the Select Link(s) to
Remove dialog box appears.
3. Select the check box for the relationship family you want to use to unlink the
records. To remove all links between the selected record and the root record,
select the Select all items? check box.
4. Click the Remove select link(s) button.
A confirmation message appears, asking if you really want to remove the link.
5. Click the Yes button.
The link is removed.
Copyright © 2017 General Electric Company. All rights reserved. • Page 155 of 280
Modifying Records in the Record Manager
Note: The Datasheet list will display multiple datasheets only if more than
one datasheet has been configured for the family to which the record belongs.
Copyright © 2017 General Electric Company. All rights reserved. • Page 156 of 280
Viewing the Datasheet for a Relationship Family
Copyright © 2017 General Electric Company. All rights reserved. • Page 157 of 280
About Printing Records in the Record Manager
In some cases, however, custom reports may be configured that will give you the addi-
tional option of printing records in a predefined report format. When reports have been
configured for a family, executing the Print command (e.g., from the Common Tasks
menu) will cause the Select Report to Print dialog box to appear.
Copyright © 2017 General Electric Company. All rights reserved. • Page 158 of 280
About Printing Records in the Record Manager
ŒHint: When this dialog box first appears, selecting the Print a copy of the data-
sheet option may not enable the OK button. If this happens, select the Print a
Report option, select a report, and then select the Print a copy of the datasheet
option, which will then enable the OK button.
l Accept the default selection, Print a report, and then select the desired report
from the list. When you select this option and click OK, the report will appear in
the Report Viewer, which serves as the print preview. From the Report Viewer, you
can print the report, export the report, or perform any other function that is avail-
able in the Report Viewer.
Custom reports can be created and then associated with entity families via the Con-
figuration Manager.
Copyright © 2017 General Electric Company. All rights reserved. • Page 159 of 280
What is Printed When You Print from the Record Manager?
In this case, the printed output would look similar to the following image.
Copyright © 2017 General Electric Company. All rights reserved. • Page 160 of 280
About the Bulk Data Form
Using the Bulk Data Form, you can create new records, modify existing records, or
delete records from the database. You can also freeze columns in the Bulk Data Form
so that when you scroll to the right, the frozen columns stay in their current location. As
with all grids, you can customize the appearance of the grid (e.g., sort the results), as
needed.
Copyright © 2017 General Electric Company. All rights reserved. • Page 161 of 280
About Accessing the Bulk Data Form
Copyright © 2017 General Electric Company. All rights reserved. • Page 162 of 280
Task Menus
Task Menus
The Bulk Data Form contains two task menus: Common Tasks and Associated Pages.
The Common Tasks menu on the Bulk Data Form page contains the following links:
l Delete: Deletes the selected record.
l Save: Saves the selected record.
l Help: Displays the context-sensitive Help topic for the Bulk Data Form.
Note: The Print, New, Save and New, Copy, Documents, and Send To options are
always disabled.
The Associated Pages menu may or may not display links, depending on the records
you are viewing. Links on the Associated Pages menu are defined for families via the
Meridium APM URL Manager. Some preconfigured links are delivered with the
Meridium APM product. Others may be configured by an administrative user. The links
that you see here will likely be intuitive, as they will apply specifically to the type of
record you are viewing and the types of tasks you can perform for that record.
Copyright © 2017 General Electric Company. All rights reserved. • Page 163 of 280
Modifying Existing Records
Copyright © 2017 General Electric Company. All rights reserved. • Page 164 of 280
Viewing Query Results in the Bulk Data Form
In the Bulk Data Form, you can modify the value in the Assigned To Name field for each
of the records.
Copyright © 2017 General Electric Company. All rights reserved. • Page 165 of 280
Freezing and Unfreezing Columns in the Bulk Data Form
Copyright © 2017 General Electric Company. All rights reserved. • Page 166 of 280
Working With a Record in a Stand-Alone Window
Copyright © 2017 General Electric Company. All rights reserved. • Page 167 of 280
About Applying a Sequence Value to Records
Copyright © 2017 General Electric Company. All rights reserved. • Page 168 of 280
About Applying a Sequence Value to Records
Note: If multiple datasheets are defined for the family on which the Sequence field
exists, the Sequence field must exist on the datasheet that will be used to display
records on the Sequencing page. This datasheet can be defined in the Sequencing URL
via the URL Manager, or it can be determined from Meridium APM logic.
To navigate to the Sequencing page, which allows you to assign a sequence value to
records, a URL must be configured. That URL can:
l Specify the root record that is linked to the records to which you want to apply a
sequence value.
-or-
l Specify a query that returns the records to which you want to apply that sequence
value.
Copyright © 2017 General Electric Company. All rights reserved. • Page 169 of 280
Configuring the Sequencing Feature
Copyright © 2017 General Electric Company. All rights reserved. • Page 170 of 280
Configuring the Sequencing Feature
apply a sequence value to Inspection Task records and Thickness Monitoring Task
records that are linked to a Motor record, define the link for the Motor family.
Copyright © 2017 General Electric Company. All rights reserved. • Page 171 of 280
How Does Meridium APM Determine Which Datasheet to Display on the Sequencing Page?
Copyright © 2017 General Electric Company. All rights reserved. • Page 172 of 280
Accessing the Sequencing Page
Copyright © 2017 General Electric Company. All rights reserved. • Page 173 of 280
Aspects of the Sequencing Page
Copyright © 2017 General Electric Company. All rights reserved. • Page 174 of 280
Aspects of the Sequencing Page
l Type the desired sequence number in the Order column for the record to which
you want to apply a new sequence value.
After you specify a new value in the Order column and navigate to another row, the row
is positioned automatically in the grid according to the specified order number. The
Sequence column will contain the order number as it is saved in the database. The
Order column will contain the order number that you specified.
For example, suppose the saved sequence for Measurement Location records looks like
the one in the following image.
In this image, you can see from the Sequence column that General Check for 19-01200
has a sequence value of 1, Pump Stroke Check for 19-00400 has a sequence value of 2,
and so on.
If you want General Check for 19-00400 to have a sequence value of 3 instead of 1, you
can select the row that contains General Check for 19-00400 and drag it to the end of the
list. The results would look like those shown in the following image.
You can see that General Check for 19-00400 is now in the third row, and the remaining
rows have been shifted up to allow it to be inserted.
The Order column displays the desired sequence value (3) and the Inspection Sequence
column displays the currently saved sequence value (1). You can compare the value in
the Order column and the Inspection Sequence column to see your changes in context
of the sequence value that existed when you first opened the page.
ŒHint: If desired, you can group the rows by any column in the grid. Grouping the
rows might help you visualize a more logical way to sequence the records than you
could determine from viewing the records in the ungrouped grid format.
After you have moved the rows according to the desired order, you can click the Save
Sequence link on the Tasks menu to save the new sequence. The Order column and the
Sequence column will then contain the same values (i.e., the specified sequence values
have been saved to the database).
ŒHint: To cancel your changes, you can click the Back button and respond No to the
prompt asking if you want to save your changes.
Copyright © 2017 General Electric Company. All rights reserved. • Page 175 of 280
The Tasks Menu
Copyright © 2017 General Electric Company. All rights reserved. • Page 176 of 280
Creating a Query To Facilitate Record Sequencing
Copyright © 2017 General Electric Company. All rights reserved. • Page 177 of 280
Parameters for the Sequencing URL
Descrip-
Parameter Name Accepted Value(s) Notes
tion
Copyright © 2017 General Electric Company. All rights reserved. • Page 178 of 280
Parameters for the Sequencing URL
Descrip-
Parameter Name Accepted Value(s) Notes
tion
Copyright © 2017 General Electric Company. All rights reserved. • Page 179 of 280
Parameters for the Sequencing URL
Descrip-
Parameter Name Accepted Value(s) Notes
tion
Copyright © 2017 General Electric Company. All rights reserved. • Page 180 of 280
Parameters for the Sequencing URL
Descrip-
Parameter Name Accepted Value(s) Notes
tion
Copyright © 2017 General Electric Company. All rights reserved. • Page 181 of 280
Parameters for the Sequencing URL
Descrip-
Parameter Name Accepted Value(s) Notes
tion
Copyright © 2017 General Electric Company. All rights reserved. • Page 182 of 280
Parameters for the Sequencing URL
Descrip-
Parameter Name Accepted Value(s) Notes
tion
those families
will be dis-
played.
l If the current Secur-
ity User has not
used the Record
Manager to open the
records that should
be sequenced and
there is no default
datasheet defined,
the datasheet that
appears first in the
list of datasheets in
the Configuration
Manager will be dis-
played. Note that if
this datasheet is a
custom form, the
Sequencing page
will not display any
datasheet, and an
error will appear
when you try to
access the page.
Copyright © 2017 General Electric Company. All rights reserved. • Page 183 of 280
Examples of the Sequencing URL
Copyright © 2017 General Electric Company. All rights reserved. • Page 184 of 280
About Managing Record States
Here, the Assign operation will change the record state from Created to Assigned, which
will then be reflected on the datasheet.
Copyright © 2017 General Electric Company. All rights reserved. • Page 185 of 280
Conditions Required to Change a Record's State
ŒHint: if the Operations link is disabled, this means that the operation is set as
reserved in the Configuration Manager.
Note that there are several other levels of restriction that can be configured between the
least restrictive and the most restrictive. Keep in mind that a user's ability to transition
record states depends upon the way in which the State Configuration has been defined.
Copyright © 2017 General Electric Company. All rights reserved. • Page 186 of 280
About Assigning Security Users to States
Note: You can assign a Security User to a state only if a State Configuration Role is
assigned to that state via the Configuration Manager.
Copyright © 2017 General Electric Company. All rights reserved. • Page 187 of 280
About Accessing the State Assignments Window
l Click the button on the datasheet toolbar. This method allows you to assign a
Security User to a state for a single record.
l Perform an action in a module or feature that allows you to assign a Security User
to a state for multiple records (i.e., Recommendation Management). In these
cases, the documentation for that module or feature describes how to manage
the state assignments for multiple records.
Copyright © 2017 General Electric Company. All rights reserved. • Page 188 of 280
Aspects of the State Assignments Window
Copyright © 2017 General Electric Company. All rights reserved. • Page 189 of 280
Aspects of the State Assignments Window
Copyright © 2017 General Electric Company. All rights reserved. • Page 190 of 280
Assigning a Security User to a State
ŒHint: In some cases, depending upon how the State Configuration has been
set up in the Configuration Manager, a Security User must also be assigned to
the successor state before a Security User can transition a record to that state.
Copyright © 2017 General Electric Company. All rights reserved. • Page 191 of 280
Removing a Security User as an Assignee
Copyright © 2017 General Electric Company. All rights reserved. • Page 192 of 280
Tips About Changing Record States
Copyright © 2017 General Electric Company. All rights reserved. • Page 193 of 280
Changing Record States
ŒHint: You can change the state of a record only after the record has been
saved.
ŒHint: The available operations are determined by the State Configuration that
is defined for the family in the Configuration Manager. In addition, if an image
has been associated with an operation via the Configuration Manager, that
image will appear to the left of the operation.
3. Click the operation that you want to use to change the record's state.
If the State Configuration is defined in a way that does not require a Security User
to be assigned to the successor state, or if a Security User is required to be
assigned to the successor state and one is already assigned, the record's state
changes, and the new state is reflected above the Operations link. In this case, you
can proceed to step 5 of these instructions.
-or-
If the State Configuration is defined in a way that requires a Security User to be
assigned to the successor state but a Security User is not currently assigned to the
successor state, the State Assignee dialog box appears. In this case, you can pro-
ceed to step 4 of these instructions.
Copyright © 2017 General Electric Company. All rights reserved. • Page 194 of 280
Changing Record States
4. On the State Assignee dialog box, select the Security User that you want to assign
to the successor state, and click OK.
The record's state changes, and the new state is reflected above the Operations
link.
5. On the Common Tasks menu, click the Save link.
The record is saved with the new state.
Copyright © 2017 General Electric Company. All rights reserved. • Page 195 of 280
Deleting Records
Deleting Records
To delete a record from the database:
1. In the Meridium APM Framework, open the record that you want to delete.
2. On the Common Tasks menu, click the Delete link.
A message window appears, asking you to confirm the deletion.
3. Click the Yes button.
The record is deleted from the database.
Note: Deleting a record from the database does not automatically delete any cor-
responding Home Page links or desktop shortcuts. You will need to delete these links
manually. If you do not delete these links, they will be non-functional.
Copyright © 2017 General Electric Company. All rights reserved. • Page 196 of 280
Introduction to Reference Documents
Copyright © 2017 General Electric Company. All rights reserved. • Page 197 of 280
Configuring the Has Reference Documents Relationship
Note: Various relationship definitions are provided for the Has Reference Docu-
ments relationship family in the baseline database. Reference document functionality
will be available automatically for any predecessor family that already participates in
one of these baseline relationship definitions. The following instructions, however, can
be used to enable reference document functional for custom families and for baseline
families for which the relationship definition is not already configured.
Copyright © 2017 General Electric Company. All rights reserved. • Page 198 of 280
Configuring the Has Reference Documents Relationship
Copyright © 2017 General Electric Company. All rights reserved. • Page 199 of 280
Configuring the Has Reference Documents Relationship
5. Select a family from the list. This should be the family for which you want to
enable reference documents functionality.
6. Click OK.
7. On the Relationship Definitions window, in the Predecessor(s) section, for the
family you added, select Zero or Many.
8. In the Successor(s) section, click the Add button.
The Successor Family List dialog box appears, displaying a list of all successor fam-
ilies.
9. Select the Reference Document family, and click OK.
10. On the Relationship Definitions window, in the Successor(s) section, select Zero
or Many.
11. Click the Save button.
The relationship definition is saved.
Copyright © 2017 General Electric Company. All rights reserved. • Page 200 of 280
About the Reference Documents Window
Depending upon your location in the Meridium APM Framework application, you will be
able to access the Reference Documents window in different ways. It will always be avail-
able in the Record Manager at the top of the datasheet area if the Has Reference Docu-
ments relationship definition has been defined for the family of the record that you are
currently viewing. You can click the Reference Documents button on the Record Man-
ager toolbar to access the Reference Documents window. Other modules provide mod-
ule-specific methods if accessing the window (e.g., from the Common Tasks menu on
the task menu pane on one or more pages in the module). Regardless of how you
access the Reference Documents window, it will always provide the same functionality.
Note: When you are viewing the datasheet area in the Record Manager, if the cur-
rent record is already linked to a Reference Document record, the icon will be
replaced with the icon.
The Reference Documents window provides various options that allow you to:
l View the actual reference document file that is currently associated with a record
(e.g., if the reference document file is a Word document, you can view the Word
Copyright © 2017 General Electric Company. All rights reserved. • Page 201 of 280
About the Reference Documents Window
Copyright © 2017 General Electric Company. All rights reserved. • Page 202 of 280
Viewing Reference Document Records in Record Manager
Copyright © 2017 General Electric Company. All rights reserved. • Page 203 of 280
Creating a New Reference Document Record
Copyright © 2017 General Electric Company. All rights reserved. • Page 204 of 280
Creating a New Reference Document Record
In the Document Path text box, you can type the path to the reference document,
or you can click the button to browse for the document. These instructions
assume that you want to browse for the document.
6. Navigate to the location where the desired file resides, select the file, and click the
Open button.
The Document Path text box is populated with the path of the selected file.
l If you are creating an internal reference document, this is the location from
which the file will be uploaded to be stored in the Meridium APM database.
l If you are creating an external reference document, this is the location in
which the document will be referenced. Only users who have permission to
access this location will be able to view this reference document.
Copyright © 2017 General Electric Company. All rights reserved. • Page 205 of 280
Creating a New Reference Document Record
7. Click OK.
The Document Path field is populated with a hyperlink to the document path.
l For internal reference documents, when you save the Reference Document
record, the document path will be replace with just the file name.
l For external reference documents, when you save the Reference Document
record, the document path will remain in this field.
8. If you want to create an internal reference document, select the check box in the
Store Document? cell. If you do not select this check box, an external reference
document will be created.
Note: If you are creating an internal reference document, when you save the
Reference Document record, the Stored By and Last Updated Date fields will be
populated automatically.
9. Click OK.
The new Reference Document record is created. If you created an internal ref-
erence document, the file that you specified will be uploaded to the database
when the record is created. Depending upon the size of the file, the upload pro-
cess may take several seconds. If so, a progress bar will appear to indicate the pro-
gress of the upload process. When the Reference Document record has been
created and the file has been uploaded (if needed), the Reference Document win-
dow closes, revealing the Reference Documents window. The name of the new
Reference Document record appears in the list of reference documents.
Copyright © 2017 General Electric Company. All rights reserved. • Page 206 of 280
Linking a Record to an Existing Reference Document Record
2. Click the Find Now button to display a list of existing Reference Document
records.
3. Highlight the row containing the desired record, and click the Select button.
The name of the Reference Document record appears in the list on the Reference
Documents window.
Copyright © 2017 General Electric Company. All rights reserved. • Page 207 of 280
Viewing the File Associated With a Reference Document
Copyright © 2017 General Electric Company. All rights reserved. • Page 208 of 280
Modifying Reference Document Records
Copyright © 2017 General Electric Company. All rights reserved. • Page 209 of 280
Unlinking Reference Document Records from a Record
Copyright © 2017 General Electric Company. All rights reserved. • Page 210 of 280
Saving a Copy of a Reference Document to a Different Location
Copyright © 2017 General Electric Company. All rights reserved. • Page 211 of 280
How Are Conditional Alerts Records Used?
Copyright © 2017 General Electric Company. All rights reserved. • Page 212 of 280
Workflow for Sending an Email Using a Conditional Alerts Record
Note: Because an Alert record is created, the user who executes the strategy
rule must have Insert privileges to the Alert family.
l If you scheduled the strategy rule to be executed automatically (rather than execut-
ing the strategy rule manually), a scheduled item is created and can be viewed
using the Schedule Manager.
Copyright © 2017 General Electric Company. All rights reserved. • Page 213 of 280
Creating a Conditional Alerts Record
Copyright © 2017 General Electric Company. All rights reserved. • Page 214 of 280
Creating a Conditional Alerts Record
3. Complete the fields as desired, and save the record when you are finished.
Note: To send an email message based upon the information in the Condi-
tional Alerts record, you must compile and execute the strategy rule MI_Pro-
cessConditionalAlerts.
Copyright © 2017 General Electric Company. All rights reserved. • Page 215 of 280
The Conditional Alert Datasheet
Field Cap-
Description Notes
tion
Alert ID Identifies the alert. The Alert ID appears as the Record ID when
you search the Conditional Alerts family. This
is a required field.
Descrip- A description of or This is a required field.
tion the purpose of the
alert.
Alert The user who created None
Owner the record.
Alert The component used Use this field to indicate the workflow that
Source to facilitate the cre- prompted the need for the Conditional Alert
ation of the record. record. For example, if you are creating the
record because of the results of a Reliability
analysis, select Reliability Analytics. If there
was no specific workflow that prompted the
record, select Manual. This is a required
field.
Query The path to the Cata- The location is set by default to Catalog
Location log folder that con- folder \\Public\Meridi-
tains the query whose um\Modules\Inspection\Conditional Alert
results you want to Queries. If you are creating the record out-
send in an email mes- side of the Inspection Management work-
sage. flow, delete the default path and type the
appropriate path instead.
Query The name of the This field lists all items in the folder specified
Name query whose results in the Query Location field. Select the appro-
you want to send in priate query from the list.
an email message.
Note that the query name must contain only
alphabetic or numeric characters. If it con-
tains non-alphabetic or non-numeric char-
acters, when you try to execute the MI_
ProcessConditionalAlerts strategy, the
strategy will fail to execute.
Copyright © 2017 General Electric Company. All rights reserved. • Page 216 of 280
The Conditional Alert Datasheet
Field Cap-
Description Notes
tion
Copyright © 2017 General Electric Company. All rights reserved. • Page 217 of 280
The Conditional Alert Datasheet
Field Cap-
Description Notes
tion
Optional Identifies users to This field lists all users whose Human
Dis- whom you want to Resource record contains an email address.
tribution send an email mes- The users are displayed in the following
sage. format:
<First Name> <Last Name> (<email address)
For example, if John Smith's email address is
[email protected], he will be listed in
the list as:
John Smith ([email protected])
Users are sorted in the list alphabetically by
last name (in ascending order). For example,
John Smith and Sarah Doe would be listed in
this order:
l Sarah Doe ([email protected])
l John Smith ([email protected])
Users you select in this field will be listed in
the Cc: field in the email message. You can
select up to 30 users.
Variable Identifies the query This field lists all fields in the query identified
Dis- field that lists email in the Query Name field. Select the field that
tribution addresses of users to returns email addresses.
Source whom you want to
send an email mes-
sage.
Group By Identifies the field by This field works in combination with other
which the query listed selections you make in the Conditional Alert
in the Query Name query and in the Conditional Alert record.
field is grouped.
Send Vari- Determines whether None
able Dis- or not the field selec-
tribution ted in the Variable Dis-
List tribution Source field
will be included in the
query results sent in
the email message.
Copyright © 2017 General Electric Company. All rights reserved. • Page 218 of 280
The Conditional Alert Datasheet
Field Cap-
Description Notes
tion
Copyright © 2017 General Electric Company. All rights reserved. • Page 219 of 280
The Conditional Alert Datasheet
Field Cap-
Description Notes
tion
Alert Para- Specifies the para- When you click in this field, you will see a
meters meters to pass into drop-down area that allows you to type each
any prompts included query parameter on a separate row. The
in the Conditional order in which you type the parameters in
Alert query. the rows must match the order in which the
prompts appear in the query. For example, if
the query prompts for an Asset Installation
Date and Asset Manufacturer, respectively,
you must specify the appropriate parameters
in that order in the Alert Parameters field.
This field is optional. If you do not specify
parameters, the email message will display
all query results in the body of the email mes-
sage (if the Send Alert Results check box is
selected). If you specify parameters, the
query results in the email message will be
filtered by those records that correspond to
the specified parameters.
Send Determines whether None
Alert or not an email mes-
When no sage is sent if the
Data? Conditional Alert
query does not return
any results.
Email Sub- The subject line of the This field is set by default to Meridium APM
ject Line email message. Alert System (Do Not Reply). You can modify
this value if desired.
Header The main heading in See the topic Example Email Generated by a
Line 1 the body of the email Conditional Alert for an example.
message.
Header The sub-heading in See the topic Example Email Generated by a
Line 2 the body of the email Conditional Alert for an example.
message.
Footer The text that appears See the topic Example Email Generated by a
Line 1 below the query res- Conditional Alert for an example.
ults in the email mes-
sage.
Copyright © 2017 General Electric Company. All rights reserved. • Page 220 of 280
The Conditional Alert Datasheet
Field Cap-
Description Notes
tion
Footer The text that appears See the topic Example Email Generated by a
Line 2 in the email below the Conditional Alert for an example.
text you typed in the
Footer Line 1 field.
Footer The text that appears See the topic Example Email Generated by a
Line 3 in the email below the Conditional Alert for an example.
text you typed in the
Footer Line 2 field.
Last Date The date on which the When you create the Conditional Alert
Pro- MI_Pro- record, this field is blank. When the MI__Pro-
cessed cessConditionalAlerts cessConditionalAlert strategy is executed,
strategy was last this field is populated with the date and time
executed. the strategy is executed. When you open a
Conditional Record that has been processed
by the MI_ProcessCondtionalAlert strategy,
you can remove the date in this field if
desired.
Active? Indicates whether or This check box is selected by default. If it is
not the Conditional cleared, when the MI_Pro-
Alert record is active. cessConditionalAlerts strategy is executed, it
will not consider this record, and an email
will not be sent based on the information in
the record.
Email Ori- The text that appears This is set by default to Alerts@Meridium
gin in the From: field in APM.Com. You can modify this value if
the email message. desired. The value you type in this field will
appear in the From: field in the email mes-
sage.
Image The path to an image The type of image you can imbed in your
Path that you want to email will depend on the type of email ser-
imbed in the email vice you are using. If you are using Microsoft
message. Outlook, standard image file types such as
.JPG, .PNG, and .BMP are supported.
Copyright © 2017 General Electric Company. All rights reserved. • Page 221 of 280
Using the Group By Functionality
Copyright © 2017 General Electric Company. All rights reserved. • Page 222 of 280
Using the Group By Functionality
The Conditional Alert record could then be set up as shown in the following image.
When the strategy is executed, one email message will be sent to Jane Doe, and one
email message will be sent to John Smith. Each email message will contain a list of
inspections that are relevant to that user.
Note: The Inspector Email Address field is not provided as a baseline Inspection
family. If you want to use this field, you would need to add it to the family manually via
the Configuration Manager. For details, see the Help system in the Configuration Man-
ager application.
Copyright © 2017 General Electric Company. All rights reserved. • Page 223 of 280
Example Email Generated by a Conditional Alert
The email message that would be generated by this Conditional Alert record would look
like the one shown in the following image.
Copyright © 2017 General Electric Company. All rights reserved. • Page 224 of 280
Example Email Generated by a Conditional Alert
Copyright © 2017 General Electric Company. All rights reserved. • Page 225 of 280
About Troubleshooting the Conditional Alerts Process
Copyright © 2017 General Electric Company. All rights reserved. • Page 226 of 280
I See an Error Indicating that a Query Cannot be Found
Copyright © 2017 General Electric Company. All rights reserved. • Page 227 of 280
I See an Error Indicating That a Recipient is Required but Not Found
Copyright © 2017 General Electric Company. All rights reserved. • Page 228 of 280
Reference Table Records
Copyright © 2017 General Electric Company. All rights reserved. • Page 229 of 280
Reference Table Records
Using this reference table, if you select H2 in the Representative Fluid field in a Criticality
Analysis record, the Fluid Type field will be populated with Flammable, the MolWt field
will be populated with 2, and so on. A rule could also be written, however, that would
allow the value in the Fluid Type field in the datasheet to populate the Representative
Fluid field based on the Representative Fluids Reference Table.
Reference tables are simply a group of records that, coupled with the appropriate code
or rules, tell fields in other records how to behave. Depending on your implementation,
you could create as many reference tables as desired and write the appropriate rules to
determine the functionality of the reference tables. Note that some Meridium APM mod-
ules rely on reference tables to populate baseline fields. In some cases, the reference
tables are configured by Meridium APM, and in other cases, you will need to configure
the reference tables manually.
Note: A datasheet and the T-Min Calculator can be populated with values from the
corresponding reference table only if it also contains all the other reference table val-
ues that Meridium APM rule logic expects it to contain, exactly as they appear in the
reference table record.
Because reference table records are accessible from the Meridium APM Framework
application, anyone with the proper security privileges for the associated family will be
able to modify and save changes to those records, thereby changing the values in the
Copyright © 2017 General Electric Company. All rights reserved. • Page 230 of 280
Reference Table Records
reference table. Note that if a reference table is modified, any analysis that was cal-
culated using the previous values becomes out-dated and must be recalculated to
reflect the changes to the reference table.
If you want to be able to quickly access an individual reference table record to modify it,
consider creating a query on the reference table family and fields, and add a hyperlink
to the query that will allow you to open and modify the record in the Record Manager or
Bulk Data Form.
Copyright © 2017 General Electric Company. All rights reserved. • Page 231 of 280
Introduction to Associated Pages
Copyright © 2017 General Electric Company. All rights reserved. • Page 232 of 280
Where Do Associated Pages Appear?
Copyright © 2017 General Electric Company. All rights reserved. • Page 233 of 280
Options for Organizing Associated Pages
l You can put them on one or more submenus, which cascadedown from the root
menu. For example, in the following figure, the same options that appear on the
previous Associated Pages menu appear instead on the Calibration submenu.
Each submenu that you create can also contain one or more submenus of its own.
If you choose to organize items on submenus, you can create one or more submenus,
each with its own set of items. In addition, when you use submenus, you can divide the
items on the menus into different groups.
Copyright © 2017 General Electric Company. All rights reserved. • Page 234 of 280
Accessing the Associated Pages that Exist for a Family
Click the button and select the desired family from the hierarchy.
The grid is populated with the Associated Pages that are already associated with
the selected family.
Note: The Associated Pages will appear on the menus in the Meridium APM Frame-
work application and in the Meridium APM Web Framework in the exact order that
they appear in the list on the Associate Families with URLs tab.
Copyright © 2017 General Electric Company. All rights reserved. • Page 235 of 280
Properties of Associated Pages
l Appears On: The name of the menu on which the Associated Page will appear.
l Caption: The label that will appear for the Associated Page. If desired, you can
manage translations for that string.
l URL: The URL that will be used to construct the link behind the Associated Page. A
value will appear in this field only for Associated Pages, not for submenus.
l Apply When: A flag that specifies when the Associated Page will appear. Each Asso-
ciated Page can appear:
n All the time: The Associated Page will always appear, regardless of other con-
ditions that exist.
n Only one record is selected: The Associated Page will appear only when one
record is selected in the search results. Note that this option applies only
when the Associated Page is displayed in the shortcut menu of search res-
ults.
n When user is a Super User or a member of the MI Power User security
group: The Associated Page will appear only when the user who is logged in
to the Meridium APM Framework is a Meridium APM Super User or a mem-
ber of the MI Power User Security Group.
l Available In: A flag that specifies where the Associated Page will be available. Each
Associated Page can be available in the:
n Meridium APM Framework and Meridium APM Web Framework
n Meridium APM Framework only
n Meridium APM Web Framework only
n Never
l Bold: A flag that indicates whether the label for the Associated Page will be dis-
played with bold text.
Copyright © 2017 General Electric Company. All rights reserved. • Page 236 of 280
Creating a New Associated Page or Submenu
Copyright © 2017 General Electric Company. All rights reserved. • Page 237 of 280
Modifying an Existing Associated Page or Submenu
Copyright © 2017 General Electric Company. All rights reserved. • Page 238 of 280
About Configuring Properties
Copyright © 2017 General Electric Company. All rights reserved. • Page 239 of 280
Aspects of the Menu Item Information Dialog Box
Copyright © 2017 General Electric Company. All rights reserved. • Page 240 of 280
Aspects of the Menu Item Information Dialog Box
The following list describes how to use each field in the Sub-Menu section:
l Appears On: Specifies the menu on which the submenu should appear. This could
be either the root menu, which appears when you right-click the cell in the query
results, or another submenu.
l Caption: The text that will appear as the title for the submenu. This field is
required.
Note: You can create a separator by typing a hyphen in the Caption field. here
l Apply When: Specifies when the submenu should appear. You can choose:
n All the time: The submenu will always appear, regardless of other con-
ditions that exist.
n Only one record is selected: The submenu will appear only when one
record is selected in the search results. Note that this option applies only
when the item is displayed in the shortcut menu of search results.
n When user is a Super User or a member of the MI Power User security
group: The submenu will appear only when the user who is logged in is a
Super User or member of the MI Power User Security Group.
l Available in: The option that indicates where the submenu should appear. You
can choose:
n Meridium APM Framework and Meridium APM Web Framework: The sub-
menu will appear in both the Meridium APM Framework and the Meridium
APM Web Framework.
n Meridium APM Framework only: The submenu will appear in the Meridium
APM Framework but not in the Meridium APM Web Framework.
n Meridium APM Web Framework only: The submenu will appear in the
Meridium APM Web Framework but not in the Meridium APM Framework.
n Never: The submenu will not appear anywhere in Meridium APM.
l Make Bold: Specifies whether or not you want the submenu header to appear in
bold text.
You can toggle between the Hyperlink section and Sub-Menu section. The fields in the
section that is not currently selected will be disabled. When you click the Save button,
Meridium APM will save the values in the currently selected section.
Copyright © 2017 General Electric Company. All rights reserved. • Page 241 of 280
Configuring Properties of an Associated Page
Note: You can specify an internal Meridium APM URL or an external URL. In
either case, you must define the scheme within the URL (e.g., meridium:// or
http://).
5. In the Apply When list, select when you want this Associated Page to appear.
Note: When configuring settings for an Associated Page that appears on a sub-
menu, you cannot choose an Apply When setting that is less restrictive than that
of the submenu on which it appears. For example, if the Associated Page
appears on the Inspection submenu, and the Inspection submenu is set to Only
one record is selected, its Associated Pages cannot be set to All the time.
6. In the Available in list, select where you want this Associated Page to appear.
7. If you want the Associated Page to appear in bold text, select the Make Bold check
box.
Note: If you decide at this point that you want to create a submenu rather
than an Associated Page, you should close the Menu Item Information dialog
box and then start over. If you select the Sub-menu option after defining prop-
erties for a Associated Page, the Associated Page that is created will contain a
combination of the information that you defined for the Associated Page and
the submenu.
Copyright © 2017 General Electric Company. All rights reserved. • Page 242 of 280
Configuring Properties of a Submenu
Note: Designating an item as a submenu means that you are not defining an
Associated Page. Rather, you are defining a menu on which Associated Page or
other submenus will appear.
2. In the Appears On list, select the menu on which the submenu should appear. The
default value is [Root Menu], but you can select a submenu if any submenus have
been created. This list is populated with an alphanumeric list of all the other sub-
menus defined for this family.
3. In the Caption text box, type the name that will be used for the submenu. If
desired, click the button to define manage translations for that string. This is a
required field.
4. In the Apply When list, select when you want this menu to appear.
Note: If you change the Apply When settings of a submenu from All the time
to a more restrictive option, a message appears, indicating that the change will
be propagated to ALL of the child items. In addition, if you are configuring set-
tings for a submenu, you cannot choose an Apply When setting that is less
restrictive than that of the menu on which the submenu appears. For example, if
the Inspection submenu appears on the Internal URLs submenu, which is con-
figured to appear Only one record is selected, the Inspection submenu cannot
be configured to appear All the time.
5. In the Available in list, select where you want this menu to appear.
6. If you want the submenu header to appear in bold text, select the Make Bold
check box.
7. Click the Save button.
Your changes are saved to the database.
Copyright © 2017 General Electric Company. All rights reserved. • Page 243 of 280
About Creating Division Between Associated Pages
The following image shows how the Associated Pages are configured to produce the divi-
sion shown in the preceding image.
Copyright © 2017 General Electric Company. All rights reserved. • Page 244 of 280
Creating a Dividing Line Between Associated Pages
Copyright © 2017 General Electric Company. All rights reserved. • Page 245 of 280
Deleting Associated Pages or Submenus
Copyright © 2017 General Electric Company. All rights reserved. • Page 246 of 280
Syntax for Variable Parameter Values in Associated Pages
Copyright © 2017 General Electric Company. All rights reserved. • Page 247 of 280
Passing Values from Records into URLs on the Associated Pages Menu
Copyright © 2017 General Electric Company. All rights reserved. • Page 248 of 280
Passing Values from Records into URLs on the Associated Pages Menu
Note: If the record you are viewing contains a NULL value in a field that is passed to
a URL parameter, an error will appear when a user tries to execute the link. Therefore,
try to pass to URLs only values from fields that are likely to contain data.
Copyright © 2017 General Electric Company. All rights reserved. • Page 249 of 280
Parameters for Search URLs
Parameter Accepted
Description Notes
Name Value(s)
Copyright © 2017 General Electric Company. All rights reserved. • Page 250 of 280
Examples of Search URLs
ŒHint: For the Families parameter, you can use alphanumeric Family IDs in
place of numeric Family Keys.
l meridium://Registry/Finder?Path=Public\Meridium\KeywordSearch
Opens the Search page and displays the saved search named KeywordSearch,
which resides in the Catalog folder \\Public\Meridium.
l meridium://Registry/Finder?Path=Public\Meridium\KeywordSearch&AutoEx-
ecute=Y
Opens the Search page, opens the search KeywordSearch, and executes the
search automatically so that the search results are displayed in the grid on the
Search page.
Copyright © 2017 General Electric Company. All rights reserved. • Page 251 of 280
Building a Link to a New Search
Copyright © 2017 General Electric Company. All rights reserved. • Page 252 of 280
Building a Link to a Saved Search
2. Select the Find existing search option, and click the Next button.
The Find Existing Search screen appears.
Copyright © 2017 General Electric Company. All rights reserved. • Page 253 of 280
Building a Link to a Saved Search
Copyright © 2017 General Electric Company. All rights reserved. • Page 254 of 280
Building a Link to a Saved Search
4. Navigate to the desired search, select it, and click the Open button.
The selected search appears in the field on the Find Existing Search screen.
5. In the URL Builder, on the Find Existing Search screen, click the Finish button.
The hyperlink is created.
Note: If you want the search to execute automatically, you can manually insert
the AutoExecute parameter after you create the base URL using the URL Builder.
(You must also provide the Path parameter when using the AutoExecute para-
meter.) Example: meridium://Registry/Finder?mode=Simple&Path=Personal[user-
]\Queries\General Insp&AutoExecute=Y
Copyright © 2017 General Electric Company. All rights reserved. • Page 255 of 280
Parameters for the Record Manager URL
Copyright © 2017 General Electric Company. All rights reserved. • Page 256 of 280
Parameters for the Record Manager URL
Copyright © 2017 General Electric Company. All rights reserved. • Page 257 of 280
Parameters for the Record Manager URL
Copyright © 2017 General Electric Company. All rights reserved. • Page 258 of 280
Parameters for the Record Manager URL
Copyright © 2017 General Electric Company. All rights reserved. • Page 259 of 280
Parameters for the Record Manager URL
l ShowRecords: Opens
the records specified
by the FamilyKey and
EntityKey parameters.
Omitting the Mode
parameter and spe-
cifying only a Fam-
ilyKey and EntityKey
parameters has the
same effect as using
the ShowRecords
ShowRecords mode.
l SelectNewRe-
SelectNewRe-
Specifies the cordType: Opens the
cordType
mode of the Select Family dialog
Mode box for creating a new
Record Man- NewExplorer
ager. record.
EditExplorer
l NewExplorer:
Launches the Defin-
able Explorer Wizard
so that you can create
a new configured
explorer.
l EditExplorer: Opens in
the Definable
Explorer Wizard the
configured explorer
specified by the
ExplorerPath para-
meter.
Copyright © 2017 General Electric Company. All rights reserved. • Page 260 of 280
Parameters for the Record Manager URL
Copyright © 2017 General Electric Company. All rights reserved. • Page 261 of 280
Parameters for the Record Manager URL
Specifying a value of
False will hide the
Record Explorer pane by
Specifies
default. This parameter
whether or
also accepts True as a
not the
value. Note, however,
Record
that specifying a value of
Explorer
True has the same effect
ShowRe- pane will be
False as omitting this para-
cordExplorer displayed by
meter from the URL: the
default when
Record Explorer pane
the Record
will be displayed. There-
Manager is
fore, you will need to use
initially
this parameter only
opened.
when you want to hide
the Record Explorer
pane.
Copyright © 2017 General Electric Company. All rights reserved. • Page 262 of 280
Examples of the Record Manager URL
ŒHint: For the DatasheetID parameter, be sure to use the Datasheet ID, not the
Datasheet Caption.
Copyright © 2017 General Electric Company. All rights reserved. • Page 263 of 280
Examples of the Record Manager URL
l meridium://Registry/RecordManager?EntityKey=1234567&DatasheetID=Custom_
Datasheet
&NewWindow=True&DialogWidth=1024&DialogHeight=768
Opens the record with the Entity Key 1234567 in a separate window that is 1,024
pixels wide and 768 pixels in height. The datasheet Custom_Datasheet is selected
by default.
l meridium://Registry/RecordManager?EntityKey=1234567&Explorer-
Path=Public\Meridium\PumpExplorer
Opens the Record Manager, displaying the record with the Entity Key 1234567.
Instead of using the standard Record Explorer pane, the configured explorer
called PumpExplorer is used.
l meridium://Registry/RecordManager?EntityKey=1234567&ShowRe-
cordExplorer=False
Opens the Record Manager, displaying the record with the Entity Key 1234567. The
Record Explorer pane is hidden by default.
l meridium://Registry/RecordManager?EntityKey=1234567&AutoExpand=True
Opens the Record Manager, displaying the record with the Entity Key 1234567. The
families that are related to the family specified by the Family Key 1234567 are
expanded to show any records in those families.
Copyright © 2017 General Electric Company. All rights reserved. • Page 264 of 280
Parameters for the URL for Linking Existing Records
Accepted
Parameter Name Description Notes
Value(s)
Copyright © 2017 General Electric Company. All rights reserved. • Page 265 of 280
Examples of the URL for Linking Existing Records
Copyright © 2017 General Electric Company. All rights reserved. • Page 266 of 280
Parameters for the URL for Creating and Linking a New Record to an Existing Record
Accepted
Parameter Name Description Notes
Value(s)
Copyright © 2017 General Electric Company. All rights reserved. • Page 267 of 280
Parameters for the URL for Creating and Linking a New Record to an Existing Record
Accepted
Parameter Name Description Notes
Value(s)
Field Values Defines val- Values that You can supply values to
ues that are appro- the new record that will be
should be priate for populated automatically
populated the spe- for that record. The actual
automatically cified fields. parameter names that you
in the data- use must correspond to
sheet. fields defined for the fam-
ily via the Configuration
Manager. The parameter
values will vary, depending
on the specified fields but
should be appropriate for
those fields (e.g., specify
numbers for numeric
fields). You must use the
field ID as the parameter
name.
FromEntityKey Specifies the The Entity This parameter is required.
existing Key of the
record to desired
which you record.
want to link a
new record.
ToFamily Specifies the The family This parameter is required.
family of the ID or the
record that Family Key
you want to of the family
create. to which the
new record
will belong.
Copyright © 2017 General Electric Company. All rights reserved. • Page 268 of 280
Parameters for the URL for Creating and Linking a New Record to an Existing Record
Accepted
Parameter Name Description Notes
Value(s)
Copyright © 2017 General Electric Company. All rights reserved. • Page 269 of 280
Examples of the URL for Creating and Linking a New Record to an Existing Record
l meridium://Registry/CreateAndLink?FromEntityKey=123456&ToFamily=MI_
REC&RelationshipFamily=MI Has Recommendations
Displays in a new window a new record in the MI_REC (Recommendation) family.
After the new record is saved, it is linked to the record defined by the Entity Key
123456 and displayed in the Record Manager. The records are linked through the
MI Has Recommendations relationship family.
l meridium://Registry/CreateAndLink?FromEntityKey=123456&ToFamily=MI_
REC&RelationshipFamily=MI Has Recommendations&RecordManager=False
After creating the Recommendation record and linking it to the record defined by
the Entity Key 123456, Meridium APM displays the screen from which the URL was
launched instead of the Record Manager.
Copyright © 2017 General Electric Company. All rights reserved. • Page 270 of 280
Creating a Link to Create a New Record
Copyright © 2017 General Electric Company. All rights reserved. • Page 271 of 280
Creating a Link to Open an Existing Record
Copyright © 2017 General Electric Company. All rights reserved. • Page 272 of 280
Creating a Link to Create a New Record and Linking it to an Existing Record
ŒHint: If you are adding this URL to a Home Page, after the URL has been
added, you will need to manually remove the text [ENTY_KEY] and replace with
the actual Entity Key of the existing record to which you want to link the new
record.
Note: The list displays only relationship families that are used in a rela-
tionship definition with the family specified by the ToFamily parameter.
10. Click anywhere outside of the Value drop-down list to close it.
Copyright © 2017 General Electric Company. All rights reserved. • Page 273 of 280
Creating a Link to Create a New Record and Linking it to an Existing Record
At this point, all required parameters have been added to the URL. You could con-
tinue defining values for the DatasheetID and RecordManager parameters if
desired. These instructions, however, assume that you do not want to add these
parameters.
11. Click the Finish button.
The URL is created. When you click the link associated with the URL:
n A new window displays a new record in the family specified by the ToFamily
parameter.
n Upon saving the new record, it is linked to the record specified by the
FromEntityKey parameter using the relationship specified by the Rela-
tionshipFamily parameter.
Copyright © 2017 General Electric Company. All rights reserved. • Page 274 of 280
Parameters for the Bulk Data Form URL
Accepted
Parameter Name Description Notes
Value(s)
Copyright © 2017 General Electric Company. All rights reserved. • Page 275 of 280
Parameters for the Bulk Data Form URL
Accepted
Parameter Name Description Notes
Value(s)
Copyright © 2017 General Electric Company. All rights reserved. • Page 276 of 280
Parameters for the Bulk Data Form URL
Accepted
Parameter Name Description Notes
Value(s)
Copyright © 2017 General Electric Company. All rights reserved. • Page 277 of 280
Parameters for the Bulk Data Form URL
Accepted
Parameter Name Description Notes
Value(s)
Copyright © 2017 General Electric Company. All rights reserved. • Page 278 of 280
Examples of the Bulk Data Form URL
Copyright © 2017 General Electric Company. All rights reserved. • Page 279 of 280
Examples of the Bulk Data Form URL
Displays in the Bulk Data Form the records with the Entity Keys 64251874617,
64251874620, and 64251874623 and sorts them in descending order by Asset ID.
Copyright © 2017 General Electric Company. All rights reserved. • Page 280 of 280