## Equipment Manager Web Service

This chapter provides an overview of the Equipment Manager web service, lists prerequisites, and discusses these web service operations:

- EquipmentProcessor

- EquipmentQueryProcessor

### Understanding the Equipment Manager Web Service

The EquipmentManager web service (JP170001) manages the processing of equipment-related web service operations. This table includes a description of the EquipmentManager web service operations:

Operation | Description
EquipmentProcessor | Use this operation to add new equipment records, or change existing equipment records in the JD Edwards EnterpriseOne system.
EquipmentQueryProcessor | Use this operation to retrieve and review equipment records that are stored in the JD Edwards EnterpriseOne database.

Accessing Javadoc for the EquipmentManager Web Service Operations

To access Javadoc for the EquipmentManager web service and its related operations, review these Javadoc packages:

- JP170001 (EquipmentManager)

- J1700001 (equipmentProcessor)

- J1700002 (equipmentQueryProcessor)

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.

### equipmentProcessor

This section provides an overview of the equipmentProcessor web service operation and lists prerequisites.

#### Understanding the EquipmentProcessor Web Service Operation

The equipmentProcessor web service operation is an inbound transaction operation that enables consumers to add new equipment records to the JD Edwards EnterpriseOne system, or to change existing equipment records. The operation uses the CRMInstalledBaseProcessing business function (N1702710) to process equipment information.

If the operation completes successfully, all data additions and changes are updated in these JD Edwards EnterpriseOne tables:

- Asset Master table (F1201)

- Equipment Master Extension table (F1217)

If the operation encounters errors while processing, no updates are made to the JD Edwards EnterpriseOne tables, and the error messages are returned to the consumer.

Setup Considerations

Before you use this operation, you can set business service properties to specify how the system processes equipment data. This table includes information about the business service properties that the EquipmentProcessor operation uses:

Group | Key | Description | Default Value
J1700001 | J1700001_EQ_MBF_VERSION | Use this property to specify the version of the Equipment Master Revisions application (P1702) that the CRMInstalledBase business function (N1702710) uses to process equipment information. | ZJDE0001

Implementation Details

This table includes information that can help determine whether the EquipmentProcessor operation is functioning correctly:

Question | Answer
How can I tell if the operation completes successfully? | If the operation completes successfully, all changes or additions are updated in the JD Edwards EnterpriseOne system. The records that are returned to the consumer 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, the system returns non-zero values for these fields: actionType assetId description unitNumber serialNumber Customer entity, which includes one or more of these fields: entityId entityLongId, entityTaxId Site entity, which includes one or more of these fields: entityId entityLongId, entityTaxId
If I encounter errors while process a transaction, do I need to reverse the transaction? | This operation uses standard transaction processing. If the system encounters errors during processing, no data in the JD Edwards EnterpriseOne system is updated. No manual updates are required.
Does this operation use record reservation? | No. The operation does not reserve records within the JD Edwards EnterpriseOne system during processing.

### EquipmentQueryProcessor

This section provides an overview of the EquipmentQueryProcessor web service operation and lists prerequisites.

#### Understanding the EquipmentQueryProcessor Web Service Operation

The EquipmentQueryProcessor web service operation is a database query operation that enables consumers to retrieve and review equipment records from the JD Edwards EnterpriseOne system. The operation retrieves data from these EnterpriseOne tables:

- Asset Master table (F1201)

- Equipment Master Extension table (F1217)

If the operation encounters errors, processing stops and the errors are returned to the consumer.

Setup Considerations

Before you use this operation, you can set business service properties to specify how the system retrieves data from the JD Edwards EnterpriseOne database. This table includes information about the business service properties that the EquipmentQueryProcessor operation uses:

Group | Key | Description | Default Value
J1700002 | J1700002_V1201R_MAX_GRID_ROWS_RETURNED | Use this business service property to specify the maximum number of records the operation can return for a query. | 20

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, which could impact performance.

Implementation Details

This table includes information that can help determine whether the EquipmentQueryProcessor operation is functioning correctly:

Question | Answer
How can I tell if the operation completes successfully? | If the operation completes successfully, zero to many records that match the selection criteria are returned to the consumer. If the operation completes successfully, but finds no matching records, a record count of zero (0) is returned. The records that are returned to the consumer 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, the system returns non-zero values for these fields: assetId description unitNumber serialNumber Customer entity, which includes one or more of these fields: entityId entityLongId, entityTaxId Site entity, which includes one or more of these fields: entityId entityLongId, entityTaxId
If I encounter errors while process 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. The operation does not reserve records within the JD Edwards EnterpriseOne system during processing.