Native Solution for Managing Attachments in WMS
With release 24C, a subscription to Oracle Content Management is no longer required to manage attachments in Oracle WMS. A native solution has been incorporated into WMS to upload, view, and delete attachments that does not require any additional subscription or configurations. The feature is supported in the following screens in WMS:
- Inbound LPN UI
- Outbound LPN UI
- Item Inventory by LPN UI
- LPN Type UI
- Inbound Shipment UI
- Outbound Load UI
- Pallet UI
- A common "Attachments UI" to view attachments related to any entity listed above
POINTS FOR CONSIDERATION
- The "Upload Files" action button has been renamed to "Upload Attachments" on all the supported screens.
- In the results pane of all supported screens, the field "Nbr Files" has been renamed to "Nbr Attachments".
- On uploading your desired attachments, the files are subject to verification via antivirus scanning.
- For optimal performance, the total size of all attachments uploaded in a single attempt is limited to 10 MB.
- Upload and Delete actions are restricted to the users that belong to the group with upload and delete permission for each of the entities.
- Attachments of the following file types are supported: .jpg, .jpeg, .png, .doc, .docx, .xls, .xlsx and .pdf.
- Attachments of type .png, .jpg and .jpeg appear as hyperlinks in WMS which can be used to preview images. Attachments of all other file types can be downloaded from WMS to view the content.
Each attachment uploaded to WMS is tagged with relevant keys that can be used as a search criterion in the Attachments UI. Depending on the screen from where the attachment has been uploaded, the keys would be different as depicted in the table below:
| Screen | Key | Note |
|---|---|---|
|
Inbound LPN UI and LPNs of Type "l" uploaded from Item Inventory by LPN UI |
Inbound LPN number |
Mandatory - Every attachment will be tagged with this key. |
|
Inbound shipment number |
Optional - Attachments will be tagged with these keys only if available at the time of uploading. |
|
|
Purchase order number |
||
|
Trailer number |
||
|
Pallet number |
||
|
Outbound LPN UI and LPNs of Type “O” uploaded from Item Inventory by LPN UI |
Outbound LPN Number |
Mandatory - Every attachment will be tagged with these keys. |
|
Outbound order number |
||
|
Outbound load number |
Optional - Attachments will be tagged with these keys only if available at the time of uploading. |
|
|
Pallet number |
||
|
LPN Type UI |
LPN Type |
Mandatory - Every attachment will be tagged with this key. |
| Inbound Shipment UI | Inbound shipment order | Mandatory - Every attachment will be tagged with this key. |
| Purchase order number |
Optional - Attachments will be tagged with these keys only if available at the time of uploading. |
|
| Trailer number | ||
| Inbound load number | Optional - Although optional, attachments will always be tagged with this key, since this data is always available. | |
| Outbound Load UI | Outbound load number | Mandatory - Every attachment will be tagged with this key. |
| Trailer number | Optional - Attachments will be tagged with this key only if available at the time of uploading. | |
| Pallet UI | Pallet Number | Mandatory - Every attachment will be tagged with this key. |
REST API TO UPLOAD ATTACHMENTS
A new “attachment/upload” REST API has been introduced to upload attachments to WMS. The attachment name along with the base 64 encoded attachment data needs to be sent in the options section of the request body.
URL
POST .../lgfapi/v10/attachment/upload/
PARAMETERS
The API supports the following parameters:
|
Name |
Required | Description |
|---|---|---|
|
company_id |
X |
This is required for all entities. |
|
facility_id |
C |
This is required only for facility level entities – Inbound LPN, Inbound Shipment, Outbound LPN, Outbound Load and Pallet. Not required for LPN Type. |
|
entity |
X |
Represents the entity (IBLPN, IBSHIPMENT, OBLPN, LPNTYPE, OBLOAD, PALLET) for which the request is being made. |
|
entity_id |
O |
Represents the unique ID of the entity, such as Container ID, IB Shipment ID. If entity_key is not populated, this field has to be populated. |
|
entity_key |
O |
Represents the number or code of the entity such Container Number, Shipment Number, LPN Type Code. If entity_id is not populated, this field has to be populated. |
- Attachment upload through this API is only allowed if the requesting user belongs to the group with upload permission for the respective entity.
- Only one attachment can be uploaded per request.
- The size of attachment is limited to 10 MB.
- Attachments are subjected to virus scanning.
- Attachments of the following file types are supported: .jpg, .jpeg, .png, .doc, .docx, .xls, .xlsx and .pdf.
REST API TO GET ATTACHMENTS
A new “attachment/get” REST API has been introduced to get the list of attachments for the requested entity from WMS.
URL
GET .../lgfapi/v10/attachment/get
PARAMETERS
The API supports the following query string parameters:
|
Name |
Required |
Description |
|---|---|---|
|
company_id |
X |
This is required for all entities. |
|
facility_id |
C |
This is required only for facility level entities - Inbound LPN, Inbound Shipment, Outbound LPN, Outbound Load and Pallet. Not required for LPN Type. |
|
entity |
X |
Represents the entity (IBLPN, IBSHIPMENT, OBLPN, LPNTYPE, OBLOAD, PALLET) for which the request is being made. |
|
entity_id |
O |
Represents the unique ID of the entity, such as Container ID, IB Shipment ID. If entity_key is not populated, this field has to be populated. |
|
entity_key |
O |
Represents the number or code of the entity such Container Number, Shipment Number, LPN Type Code. If entity_id is not populated, this field has to be populated. |
REST API TO DELETE ATTACHMENTS
A new “attachment/delete” REST API has been introduced to delete attachments from WMS. The list of attachment IDs needs to be sent in the options section of the request body. The attachment ID is internal to WMS and can be retrieved using the “attachment/get” API described earlier.
URL
POST .../lgfapi/v10/attachment/delete/
PARAMETERS
The API supports the following parameters:
|
Name |
Required |
Description |
|---|---|---|
|
company_id |
X |
This is required for all entities. |
|
facility_id |
C |
This is required only for facility level entities – Inbound LPN, Inbound Shipment, Outbound LPN, Outbound Load and Pallet. Not required for LPN Type. |
|
entity |
X |
Represents the entity (IBLPN, IBSHIPMENT, OBLPN, LPNTYPE, OBLOAD, PALLET) for which the request is being made. |
|
entity_id |
O |
Represents the unique ID of the entity, such as Container ID, IB Shipment ID. If entity_key is not populated, this field has to be populated. |
|
entity_key |
O |
Represents the number or code of the entity such Container Number, Shipment Number, LPN Type Code. If entity_id is not populated, this field has to be populated. |
The response of this API contains the new count of number of attachments in WMS after attachments have been successfully deleted for the requested entity.
Steps to Enable
You don't need to do anything to enable this feature.