AMS Asset Data Source records store connection information about AMS Data Sources that GE Digital APM uses to pull data into GE Digital APM. This topic provides a list and description of the fields that exist for the AMS Asset Data Source family and appear in the sections on the AMS Data Source Configuration: New Data Source datasheet.
This family is enabled for site filtering, which means that records in this family can be assigned to a specific site, and will then only be accessible to users who are assigned to the same site and have the appropriate license and family privileges. See the Site Filtering section of the documentation for more information on using this feature.
The Web Service Details section of the AMS Data Source Configuration: New Data Source data sheet stores connection information about the web services that the GE Digital APM uses to connect to the AMS Analytics data source.
This section provides an alphabetical list and description of the fields that exist in the Web Service Details section and appear on the AMS Data Source Configuration: New Data Source datasheet. The information in the table reflects the baseline state and behavior of these fields.
Field |
Data Type |
Description |
Behavior and Usage |
---|---|---|---|
CMMS Data Source |
Boolean |
This field is no longer used. |
N/A |
Enabled |
Boolean |
Enable connection to the web service. |
The value in this field determines whether or not GE Digital will attempt to retrieve data from this AMS Analytics data source when the scheduled item is executed. When the AMS Asset Data Source record is created, the Enabled check box is selected by default, indicating that the connection is enabled. You can clear the Enabled check box to disable the data source connection. |
Name |
Character |
Name of the AMS Analytics data source to identify the record. |
This field is required and must be unique. If you try to save the record with the same value in the Name field as an existing AMS Asset Data Source record, a message appears, indicating that the name is not valid. |
Network Domain |
Character |
The name of the network domain associated with the AMS Analytics data source used to access the web service. |
This field is required only if you must first log in to a network to access the web service for the AMS Analytics data source. The GE Digital APM system will use this information only if the Use Network Credentials? check box is selected. |
Network Password |
Character |
The password for the User ID used to access the network. |
This field is disabled. To modify this field, click the button to the right of the field, and on theEnter AMS Asset Data Source Password dialog box, type the password and then click OK. This field is required only if you must first log in to a network to access the web service. The GE Digital APM system will use this information only if the Use Network Credentials? check box is selected. |
Network User ID |
Character |
The User ID used to access the network. |
This field is required only if you must first log in to a network to access the web service for the AMS Analytics data source. The GE Digital APM system will use this information only if the Use Network Credentials? check box is selected. |
Password |
Character |
The password for the User ID used to access the AMS Analytics data source. Log in to the data source at the location specified in the URL text box. |
This field is disabled. To modify this field, click the button to the right of the field, and on theEnter AMS Asset Data Source Password dialog box, type the password and then click OK. |
Proxy Port |
Numeric |
The port number of the proxy server. |
This field is required if a port number is associated with the proxy server. The GE Digital APM system will use this information only if the Use Proxy? check box is selected. |
Proxy URL |
Character |
The URL to the proxy server to access the web service. |
This field is required only if you must first access a proxy server to access the web service for the AMS Analytics data source. The GE Digital APM system will use this information only if the Use Proxy? check box is selected. |
Queue Server |
Character |
The APM server configured for message queues. |
If Message Queuing is enabled, this field is required and must be in the following format: FormatName:Direct=OS:<server>\private$ where <server> is the name of the GE Digital APM server. |
Queue Timeout |
Numeric |
The amount of time in seconds before the connection between AMS Data source and GE Digital APM times out if no responses are received. |
After the time limit is reach and error is generated, and the connection to the message queue is closed. |
Request Queue |
Character |
The name of request queue on the GE Digital APM Server. |
None |
Response Queue- |
Character |
The name of the response queue on the GE Digital APM server. |
None |
URL |
Character |
The URL for accessing the web service associated with the AMS Analytics data source. |
This field is required. After you type a URL in this field and navigate to a different field, parameters on the Detailed Report Details tab are populated automatically based upon the AMS Analytics data source that you specify in the URL. Not all the fields on this tab are populated for all AMS Analytics data sources. For more information, see the description of the Detailed Report Details tab. |
User ID |
Character |
The User ID used to access the AMS Analytics data source. Log in to the data source at the location specified in the URL text box. |
This field is required. |
Use Massage Queuing | Boolean | Enables message queues when collecting data from the AMS data source. | None |
Use Network Credentials? |
Boolean |
Enable network connection information. |
Select this check box to indicate that the GE Digital APM system should use the network connection information when accessing the web service. |
Use Proxy? |
Boolean |
Enable proxy connection information. |
The value in this field indicates that GE Digital APM should use proxy connection information when accessing the web service. |
The Detailed Report Details section of the AMS Data Source Configuration: New Data Source datasheet store connection information that GE Digital APM uses to obtain data from an AMS Analytics data source including:
This section provides an alphabetical list and description of the fields that exist for the Detailed Report Details section and appear on the AMS Data Source Configuration: New Data Source datasheet. The information in the table reflects the baseline state and behavior of these fields.
Note: All the fields on the Detailed Report Details record are populated automatically when you enter and save a valid URL in the URL text box on the Web Service Details record.
Field |
Data Type |
Description | Behavior and Usage |
---|---|---|---|
AMS Asset Alert Detail Report Path |
Character |
The GE Digital APM Catalog path \\Public\Meridium APM\Modules\AMS Asset Portal\Detailed Reports\<Data Source Name>, where <Data Source Name> is the name of the Catalog folder where the Alert Details Report is stored. |
Locate the associated Alert Details Report for the desired AMS Analytics data source. |
AMS Asset Alert XSL Path |
Character |
The URL http:// <Application Server Name>/DetailReportService/XSL/<Data Source Name>/GetAlertDetails.xsl, where <Application Server Name> is the name of the GE Digital APM Application server and <Data Source Name> is the name of the folder where the file GetAlertDetails.xsl is stored. |
Transform the data from the AMS Analytics data source into the format required to display the report in GE Digital APM. |
AMS Asset Detail Report Path |
Character |
The GE Digital APM Catalog path \\Public\Meridium APM\Modules\AMS Asset Portal\Detailed Reports\<Data source Name>, where <Data Source Name> is the name of the Catalog folder where the Asset Details Report is stored. |
Locate the associated Asset Details Report for the desired AMS Analytics data source. |
AMS Asset Detailed Report Web Service URL |
Character |
The URL http://<Application Server Name>/DetailReportService/DetailReporting.asmx, where <Application Server Name> is the name of the GE Digital APM Application server where the file DetailReporting.asmx is stored. |
Connect to the data source specified on the Web Service Details tab and obtain the required content from the data source. |
AMS Asset Event Detail Report Path |
Character |
The GE Digital APM Catalog path \\Public\Meridium APM\Modules\AMS Asset Portal\Detailed Reports\<Data Source Name>, where <Data Source Name> is the name of the Catalog folder where the Event Details Report is stored. |
Locate the associated Event Details Report for the desired AMS Analytics data source. |
AMS Asset Event XSL Path |
Character |
The URL http://<Application Server Name>/DetailReportService/XSL/<Data Source Name>/GetEventDetails.xsl, where <Application Server Name> is the name of the GE Digital APM Application server and <Data Source Name> is the name of the folder where the file GetEventDetails.xsl is stored. |
Transform the data from the AMS Analytics data source into the format required to display the report in GE Digital APM. |
AMS Asset XSL Path |
Character |
The URL http://<Application Server Name>/DetailReportService/XSL/<Data Source Name>/GetAssetDetails.xsl, where <Application Server Name> is the name of the GE Digital APM Application server and <Data Source Name> is the name of the folder where the file GetAssetDetails.xsl is stored. |
Transform the data from the AMS Analytics data source into the format required to display the report in GE Digital APM. |
The Scheduling Settings section of the AMS Data Source Configuration: New Data Source datasheet stores information about:
This topic provides an alphabetical list and description of the fields that exist in the Scheduling Settings section and appear on the AMS Data Source Configuration: New Data Source datasheet. The information in the table reflects the baseline state and behavior of these fields.
Field |
Data Type |
Description |
Behavior and Usage |
---|---|---|---|
AMS Asset Schedule |
Character |
Specifies how often data should be collected from the specified AMS Analytics data source to create and update records in the AMS Asset family. |
None |
AMS Asset Alert Schedule | Character | Specifies how often data should be collected from the specified AMS Analytics data source to create and update records in the AMS Asset Alert family. | None |
AMS Asset Event Schedule | Character | Specifies how often data should be collected from the specified AMS Analytics data source to create and update records in the AMS Asset Event family. | None |
AMS Asset Event History | Numeric | Specifies which AMS Asset Event records should be collected based on when the associated events occurred. | For example, if you wanted to see AMS Asset Event records for events that took place only over the past two months, you would the number 2 and then select the value Months from the list. |
The Status section of the AMS Data Source Configuration: New Data Source datasheet stores information about the dates on which data was last collected and the status of the collection process.
This section provides an alphabetical list and description of the fields that exist in the Status section and appear on the AMS Data Source Configuration: New Data Source datasheet. The information in the table reflects the baseline state and behavior of these fields.
Field |
Data Type |
Description |
Behavior and Usage |
---|---|---|---|
AMS Asset Alert Last Successfully Processed Date |
Character |
Stores the date and time on which data for the AMS Asset Alert family was collected from the specified AMS Analytics data source. |
The field is populated automatically after the collection process for the AMS Asset Alert family is executed successfully. |
AMS Asset Alert Last Processed Status |
Character |
Stores a value that indicates if there were errors while collecting AMS Asset data. |
This field is populated automatically after the collection process for the AMS Asset Alert family is complete. If no errors occurred, the value Good will appear. If errors have occurred, this value will reflect the type of error that occurred (e.g., Fatal Error). If the CMMS Data Source check box on the Web Service Details tab is selected, this value will always be N/A. |
AMS Asset Event Last Successfully Processed Date |
Numeric |
Stores the date and time on which data for the AMS Asset Event family was collected from the specified AMS Analytics data source. |
The field is populated automatically after the collection process for the AMS Asset Event family is executed successfully. |
AMS Asset Event Last Processed Status |
Character |
Stores a value that indicates if there were errors while collecting AMS Asset Event data. |
This field is populated automatically after the collection process for the AMS Asset Event family is complete. If no errors occurred, the value Good will appear. If errors have occurred, this value will reflect the type of error that occurred (e.g., Fatal Error). If the CMMS Data Source check box on the Web Service Details tab is selected, this value will always be N/A. |
AMS Asset Last Successfully Processed Date |
Numeric |
Stores the date and time on which data for the AMS Asset family was collected from the specified AMS Analytics data source. |
The field is populated automatically after the collection process for the AMS Asset family is executed successfully. |
AMS Asset Last Processed Status |
Character |
Stores a value that indicates if there were errors while collecting AMS Asset data. |
This field is populated automatically after the collection process for the AMS Asset family is complete. If no errors occurred, the value Good will appear in the field. If errors have occurred, this value will reflect the type of error that occurred (e.g., Fatal Error). |
Copyright © 2018 General Electric Company. All rights reserved.