Understanding the Capital Asset Manager Web Service
This chapter provides an overview of the Capital Asset Manager web service, lists prerequisites, and discusses these web service operations:
createCapitalAssetConditionBasedAlert
getCapitalAssetConditionBasedAlert
Understanding the Capital Asset Manager Web Service
The CapitalAssetManager web service (JP130000) manages the processing of capital asset-related web service operations. This table includes a description of the capital asset web service operations:
|
Operation |
Description |
|
createCapitalAssetConditionBasedAlert |
Use this operation to add capital asset condition-based alerts within the JD Edwards EnterpriseOne Plant and Equipment Management system. |
|
getCapitalAssetConditionBasedAlert |
Use this operation to query the JD Edwards EnterpriseOne database for existing capital asset condition-based alerts. |
Accessing Javadoc for the Capital Asset Manager Web Service Operations
To access Javadoc for the Capital Asset Manager web service and its related operations, review these Javadoc packages:
JP130000 (CapitalAssetManager)
J1300001 (createCapitalAssetConditionBasedAlert)
J1300002 (getCapitalAssetConditionBasedAlert)
See Accessing Javadoc for Business Services.
Reviewing Input and Response Interfaces
To review information about the classes and fields that are used by these web service operations, you can review the input and response interface tables. Input and response interface tables list the classes and fields used by each operation, the key fields, the data types of each fields, and which fields or classes are required for each action.
See Accessing Additional Information about Business Services, Appendix A: Input and Response Interfaces.
Prerequisites
Before using the Capital Asset Manager web service, or any of the related web service operations, you must install and configure the JD Edwards EnterpriseOne Capital Asset Management product including the JD Edwards EnterpriseOne Plant and Equipment Management and JD Edwards EnterpriseOne Condition-Based Maintenance systems.
See Getting Started with JD Edwards EnterpriseOne Capital Asset Management.
See Getting Started with JD Edwards EnterpriseOne Condition-Based Maintenance.
createCapitalAssetConditionBasedAlert
This section provides an overview of the createCapitalAssetConditionBasedAlert web service operation and discusses how to set processing options for XPI Condition-Based Alerts (P1301150).
Understanding the createCapitalAssetConditionBasedAlert Web Service Operation
The createCapitalAssetConditionBasedAlert web service operation is an inbound transaction operation that enables consumers to process condition-based alert information within the JD Edwards EnterpriseOne system. The consumer can add capital asset condition-based alerts in the JD Edwards EnterpriseOne Plant and Equipment Management system.
If the operation is successful, the system creates condition-based alerts and commits the records.
If the operation fails, the system returns error messages to the consumer.
The createCapitalAssetConditionBasedAlert web service operation calls the XPIConditionBasedAlert master business function (N1301150) to process the capital asset record. When a condition-based alert is successfully created, a condition-based alert key is returned to the caller through the Alert ID. Exceptions are sent to the caller. The minimum required fields to create a condition-based alert in JD Edwards EnterpriseOne are equipmentNumber, alertLevel, eventDate, eventTime, description, and automatedResponseType.
Supported Functionality
This section discusses the functionality that the createCapitalAssetConditionBasedAlert operation supports.
Note. If functionality is not explicitly documented as supported functionality, it is to be understood that the functionality is not supported by the integration solution.
The createCapitalAssetConditionBasedAlert operation supports adding capital asset condition-based alerts in the JD Edwards EnterpriseOne Plant and Equipment Management system.
The createCapitalAssetConditionBasedAlert operation does not support updating or deleting capital asset condition-based alerts.
Setup Considerations
Before you use this operation, you can set business service properties to specify how the system processes condition-based alert information. This table includes information about the business service properties that the createCapitalAssetConditionBasedAlert web service operation uses:
|
Group |
Key |
Description |
Default Value |
|
J1300001 |
J1300001_CBA_MBF_VERSION |
Use this business service property to specify which version of the XPI Condition-Based Alerts program (P1301150) the operation uses. |
ZJDE0001 |
|
J1300001 |
J1300001_PREFIX_1 |
Use this business service property to specify the prefix value the operation uses for error messages. |
Capital Asset Send In |
See JD Edwards EnterpriseOne 8.98 Business Services Development Methodology Guide, Creating a Business Service, Managing Business Service Properties
Implementation Details
The following table includes information that can help determine whether the createCapitalAssetConditionBasedAlert operation is functioning correctly:
|
Question |
Answer |
|
How can I tell if the operation completes successfully? |
If the operation completes successfully, the system does not return an error message. If the operation succeeds and returns records, the system returns non-zero values for these fields:
|
|
If I encounter errors while processing a transaction, do I need to reverse the transaction? |
This operation uses standard transaction processing. Therefore, if you encounter errors during processing, the system does not update any information in the JD Edwards EnterpriseOne system. No manual update is necessary. |
|
Does this operation use record reservation? |
No. This operation does not reserve records. |
Setting Processing Options for XPI Condition-Based Alerts (P1301150)
Processing options enable you to specify the default processing for programs and reports.
For programs, you can specify options such as the default values for specific transactions, whether fields appear on a form, and the version of the program that you want to run.
Process
|
1. Equipment Number Format |
Specify how the system validates the equipment number. Values are: 1: Use the equipment number. This is the default value. 2: Use the unit number. 3: Use the serial number. |
Versions
|
1. Condition-Based Alerts Revisions (P1311) Version |
Specify the version that the system uses for the Condition-Based Alerts Revisions program (P1311). If you leave this processing option blank, the system uses the ZJDE0001 version. |
|
2. Condition-Based Alerts Processor (R1312) Version |
Specify which version of the Condition-Based Alerts Processor program (R1312) the system uses when processing the automated responses of condition-based alerts. If you leave this processing option blank, the system does not process the automated responses of condition-based alerts. Note: If you leave this processing option blank, you must run a version of the Condition-Based Alerts Processor program (R1312) in order to complete the automated response-type processing. |
getCapitalAssetConditionBasedAlert
This section provides an overview of the getCapitalAssetConditionBasedAlert web service operation.
Understanding the getCapitalAssetConditionBasedAlert Web Service Operation
The getCapitalAssetConditionBasedAlert web service operation is a database query operation that enables consumers to query the JD Edwards EnterpriseOne Plant and Equipment Management system to retrieve existing capital asset data. The getCapitalAssetConditionBasedAlert operation invokes a database operation to retrieve capital asset information from the Condition-Based Alerts table (F1310) in JD Edwards EnterpriseOne based on the selection criteria specified in the value object.
The getCapitalAssetConditionBasedAlert web service operation allows an open query.
Note. An open query of the JD Edwards EnterpriseOne database impacts system performance. It is strongly recommended that you set the Max Rows business service property to a value other than 0 (zero). If you leave this value set to 0, the system returns all matching records. Additionally, it is recommended that you specify selection criteria when you query the JD Edwards EnterpriseOne database.
If the operation is successful, the system returns zero to many records to the consumer. You can specify the maximum number of records to return during a query using the Max Rows business service property.
If the operation fails, the system returns an error message to the consumer.
The getCapitalAssetConditionBasedAlert web service operation queries the JD Edwards EnterpriseOne condition-based alert information in a real-time fashion. The web service operation, getCapitalAssetConditionBasedAlert, is called by the source system. This web service operation consumes a published interface, GetCapitalAssetConditionBasedAlert, which exposes the selection criteria for retrieving the condition-based alert information from the F1310 table in JD Edwards EnterpriseOne. The fields in GetCapitalAssetConditionBasedAlert are used to set the selection in the getCapitalAssetConditionBasedAlert integration. The web service operation returns results in the ShowCapitalAssetConditionBasedAlert published interface.
These fields are optional to process the getCapitalAssetConditionBasedAlert integration:
alert
alertId
description
problemDescription
alertLevelCode
alertStatusCode
dateEstimatedStart
assignedWorkOrder
serviceTypeCode
dateRequested
equipment
itemAsset
unitNumber
serialNumber
measurementLocationCode
itemTestId
site
entityId
entityLongId
entityTaxId
customer
entityId
entityLongId
entityTaxId
originator
entityId
entityLongId
entityTaxId
notificationRecipient
entityId
entityLongId
entityTaxId
investigationRecipient
entityId
entityLongId
entityTaxId
Note. The system adjusts the date time stamp entered to Coordinated Universal Time (UTC), which the system determines using the time zone on your business service server, unless an offset is used. For example, if the business service server is GMT-7, entering 2007-01-18T00:00:00.000 results in an adjustment to this value of -7 hours, and the actual value that passes in to JD Edwards EnterpriseOne becomes 2007-01-17T17:00:00.000. An offset can be passed in with the original value so that these adjustments do not occur, such as 2007-01-18T00:00:00.000-7:00, which offsets by 7 hours from UTC, resulting in the date being passed into JD Edwards EnterpriseOne as 2007-01-18T00:00:00.000.
Supported Functionality
This section discusses the functionality that the getCapitalAssetConditionBasedAlert operation supports.
Note. If functionality is not explicitly documented as supported functionality, it is to be understood that the functionality is not supported by the integration solution.
The getCapitalAssetConditionBasedAlert operation supports a database query operation that enables consumers to query the JD Edwards EnterpriseOne Plant and Equipment Management system to retrieve existing capital asset data.
The getCapitalAssetConditionBasedAlert operation does not support the wildcard (asterisk (*)) for search criteria.
Setup Considerations
Before you use this operation, you can set business service properties to specify how the system processes capital asset information. This table includes information about the business service properties that the getCapitalAssetConditionBasedAlert web service operation uses:
|
Group |
Key |
Description |
Default Value |
|
J1300002 |
J1300002_F1310_MAX_GRID_ROWS_RETURNED |
Use this business service property to define the maximum number of rows that the operation returns when querying the JD Edwards EnterpriseOne database. |
100 |
Note. It is strongly recommended that you set this business service property to a value other than 0 (zero). If you leave this value set to 0, the system returns all matching records. Additionally, it is recommended that you specify selection criteria when you query the JD Edwards EnterpriseOne database.
See JD Edwards EnterpriseOne 8.98 Business Services Development Methodology Guide, Creating a Business Service, Managing Business Service Properties
Implementation Details
The following table includes information that can help determine whether the getCapitalAssetConditionBasedAlert operation is functioning correctly:
|
Question |
Answer |
|
How can I tell if the operation completes successfully? |
If the operation completes successfully, the system does not return an error message. If the operation completes successfully, the system returns records that match your search criteria. These records include all of the fields that are listed in the response interface for this operation. However, some of those fields can contain blank or zero values, depending on the data that exists in the JD Edwards EnterpriseOne system. At a minimum, if the query finds matching records, the system returns non-zero values for these fields:
The operation may complete successfully without returning rows because the selection criteria did not match any records in the database or an open query was performed and there were no records. This is considered successful and provides valid information. |
|
If I encounter errors while processing a transaction, do I need to reverse the transaction? |
This is a database query operation that does not perform transactions. If you encounter errors during processing, review your search criteria and business service property settings and try your query again. If the operation does not return any records, verify that records matching your query exist in the JD Edwards EnterpriseOne database. |
|
Does this operation use record reservation? |
No. This operation does not reserve records that are returned in a query. |