Integration to OnGoing
OnGoing is a cloud based WMS system. It might be integrated with SHARK using its SOAP Automation API.
References
Notes
- The user in Shark will be reported to Ongoing unless explicitly specified in the "User" field.
The user must exists in Ongoing.
Mapping of Ongoing - SHARK fields.
Outbound Orders
| SHARK Field |
Ongoing Field |
Notes |
| Order.OrderNumber |
Order/OrderNumber |
The SHARK order number is taken directly from Ongoing order number. |
| Order.DeliveryNoteNumber |
WorkOrderId |
|
| Order.OrderType |
— |
Fixed value from the action's OutboundOrderTypeID parameter, not sourced from Ongoing. The default value is "1" |
| Order.CustomerNumber |
Order/Consignee/CustomerNumber |
|
| Order.CustomerName |
Order/Consignee/Name |
|
| Order.Country |
Order/Consignee/CountryCode |
|
| Order.Misc1 |
Article/GoodsOwnerName |
|
| Order.Misc2 |
Order/OrderId |
List of OrderID's from Ongoing for the same article and for the same order. The list is later used for confirmation back to Ongoing when picked. |
| Order.Misc3 |
pickOrderID |
|
| OrderLine.ItemID |
Article/ArticleNumber |
The article number and owner is looked up in Shark and converted to ItemID. |
| OrderLine.ItemCount |
NumberOfItems |
Parsed as a double; defaults to 1.0 and logs an error if unparsable. On merge, quantities of all merged items are summed. |
| OrderLine.Misc1 |
ArticleItemId |
Semicolon-separated list (;) when multiple Ongoing items merge into this line. |
| OrderLine.Misc2 |
Order/PickOrder/PickingCart/PickingCartName + "-" + Order/PickOrder/BinIndex |
Combined as <PickingCartName>-<BinIndex>. Taken from the first merged item only. It might be used to match a SHARK position on a pick cart. |
| OrderLine.Misc3 |
NumberOfItems |
Semicolon-separated list of the individual quantities that were merged into this line (qtyList). |
| OrderLine.Misc4 |
Order/PickOrder/PickOrderType/PickOrderTypeCode |
Taken from the first merged item only. |
| OrderLine.Misc5 |
Order/PickOrder/PickOrderType/PickOrderTypeName |
Taken from the first merged item only. |
Inbound Orders
| SHARK Field |
Ongoing Field |
Notes |
| Order.OrderNumber |
ArticleItemInLocationId |
Taken from the first item that creates the line — not a real Ongoing order number, just reused as a SHARK order identifier. Also the merge key is ArticleNumber only, so this value is not re-derived when later items merge into the same line. |
| Order.OrderType |
— |
Fixed value from the action's InboundOrderTypeID parameter, not sourced from Ongoing. |
| Order.ItemNumber |
Article/ArticleNumber |
Also the merge key. |
| Order.ItemCount |
NumberOfItems |
Parsed as a double; defaults to 1.0 and logs an error if unparsable. On merge, quantities of all merged items are summed. |
| Order.Owner |
Article/GoodsOwnerName |
Taken from the first item that created the line; not updated by later merges. |
| Order.BatchNumber |
OriginalArticleItemId |
Taken from the first item that created the line; not updated by later merges. |
| Order.BatchDate |
— |
Set to the current timestamp (new Date()) when the line is created. Not sourced from Ongoing. |
| OrderLine.Misc1 |
ArticleItemId |
Semicolon-separated list (;) when multiple Ongoing items merge into this line. |
Article Master Data Mapping
| SHARK Field |
Ongoing Field |
Notes |
| Article.ArticleNumber |
Article/ArticleNumber |
|
| Article.Description |
Article/ArticleName |
In the simple branch (CreateReplenishmentInfo=false), falls back to ArticleNumber when ArticleName is empty; the replenishment branch does not fall back. |
| Article.Owner |
Article/GoodsOwnerName |
Only set when the UseOwner parameter is true. |
| Article.Misc1 |
Article/ArticleDefId |
|
| Article.Misc2 |
Article/LinkToPicture |
URL from Ongoing to a picture of the article. |
| Article.Misc3 |
Article/GoodsOwnerID |
Only set when the UseOwner parameter is true. Stored for the master data, it is required when making stock adjustments in Ongoing |
| Article.Misc4 |
Article/ArticleDef |
Article ID (ArticleDef) number used by Ongoing. |
| Article.EAN |
Article/BarCode |
In the simple branch, only set when BarCode is non-empty; the replenishment branch always sets it (even if empty). |
Replenishment info (only when CreateReplenishmentInfo=true)
Optional creating of replenishment info.
| SHARK Field |
Ongoing Field |
Notes |
| PackageSize.ItemNumber |
Article/ArticleNumber |
|
| PackageSize.Name, Size, Depth, Width, Height |
— |
Fixed values ("P1", 1.0, 1.0, 1.0, 1.0). Not sourced from Ongoing. |
| Replenishment.BoxType |
— |
From the action's ReplenishmentLocationType parameter, not Ongoing. |
| Replenishment.Zone |
— |
From the action's ReplenishmentZone parameter, not Ongoing. |
| Replenishment.Qty, PackageName |
— |
Fixed values (999999, "P1"). Not sourced from Ongoing. |
| LocationQuantity |
— |
Built from the ReplenishmentLocationType parameter and a fixed quantity of 999999. Not sourced from Ongoing. |
Flow Actions
The following are the Actions defined especially for OnGoing.
| Action |
Description |
| Adjust Acknowledge |
Confirm a stock adjustment document to Ongoing. |
| Get Inbound Orders |
Read articles that has to be moved from the In_Location to SHARK. |
| Get Inventory Orders |
|
| Get Outbound Orders |
Get articles from Ongoing supposed to be delivered to the out location. |
| Order Acknowledge |
Parse a SHARK acknowledge XML document and conform each order line to Ongoing by moving the article to the specified out location. |
| Update Article Master Data |
Read Article Master Data information from Ongoing and update the SHARK article master data. Do not run this too often, it is a lengthly database heavy operation. |
Ongoing/Adjust Acknowledge
Confirm a stock adjustment document to Ongoing.
Parameters
| Parameter |
Type |
Description |
| UserName |
TEXT |
Ongoing REST API User Name. |
| Password |
TEXT |
Ongoing SOAP API Password. |
| URL |
TEXT |
URL for the Ongoing SOAP API. |
| Debug |
BOOLEAN |
Generate additional log messages. |
| HandleOrderID |
INTEGER |
Only document with this OrderID will be handled by this action. |
| LogToSystemLog |
BOOLEAN |
Log to the Shark System Log. |
| MovedByUser |
TEXT |
If empty use the user name from the document as Ongoing user, else use this name. The user must exists in Ongoing. |
Ongoing/Get Inbound Orders
Read articles that has to be moved from the "In Location" to SHARK.
SHARK uses the SOAP request GetArticleItemsByQuery and check for articles placed on the "In Location". If any articles
are found an inbound order will be created in SHARK, one order for each article. The Ongoing parameter
"ArticleItemInLocationId" is used as order number in SHARK. When the article has been moved into SHARK, the movement
will be confirmed to Ongoing.
Parameters
| Parameter |
Type |
Description |
| UserName |
TEXT |
User name for the Ongoing REST API. |
| Password |
TEXT |
Password for the Ongoing REST API. |
| URL |
TEXT |
URL for the Ongoing REST API. |
| LocationIn |
TEXT |
The Ongoing location where articles are stored for triggering the inbound operation. |
| MaxLines |
INTEGER |
Max number of articles to read from Ongoing in one call. |
| Debug |
BOOLEAN |
If true, additional information will be printed. |
| UseOwner |
BOOLEAN |
If not empty, use this user reporting to Ongoing (user must exists in Ongoing). |
| BatchNumberAlwaysRequired |
BOOLEAN |
Set the article to require batchnumber in SHARK. |
| CreateReplenishmentInfo |
BOOLEAN |
Create the article with replenishment information. |
| ReplenishmentZone |
TEXT |
Zone for replenishment. |
| ReplenishmentLocationType |
TEXT |
Location type for replenishment. |
| InboundOrderTypeID |
INTEGER |
Order Type ID for created inbound order. |
| MarkAsHandled |
BOOLEAN |
Mark the article as handled in Ongoing (if false the article will be returned fromOngoing at each call) |
| LogToSystemLog |
BOOLEAN |
Log activity to the Shark System Log. |
| ForceReadAll |
BOOLEAN |
Force read of all orders regardless of the Handled flag. |
Ongoing/Get Inventory Orders
Parameters
| Parameter |
Type |
Description |
| UserName |
TEXT |
|
| Password |
TEXT |
|
| URL |
TEXT |
|
| Location |
TEXT |
|
| MaxLines |
INTEGER |
|
| Debug |
BOOLEAN |
|
| UseOwner |
BOOLEAN |
|
| BatchNumberAlwaysRequired |
BOOLEAN |
|
Ongoing/Get Outbound Orders
Get articles from Ongoing supposed to be delivered to the out location.
Parameters
| Parameter |
Type |
Description |
| UserName |
TEXT |
User name for the Ongoing REST API. |
| Password |
TEXT |
Password for the Ongoing REST API. |
| URL |
TEXT |
URL for the Ongoing REST API. |
| LocationIn |
TEXT |
Ongoing location for the articles to be picked. |
| LocationShark |
TEXT |
Location in SHARK. |
| MaxLines |
INTEGER |
Max articles to read in one call. |
| Debug |
BOOLEAN |
Generates additional debug information. |
| UseOwner |
BOOLEAN |
Use SHARK owners. |
| OutboundOrderTypeID |
INTEGER |
Order Type ID for outbound orders. |
| MarkAsHandled |
BOOLEAN |
Mark articles as handled in Ongoing if order is created. |
| LogToSystemLog |
BOOLEAN |
Log activity to the Shark System Log. |
| ForceReadAll |
BOOLEAN |
Force read of all orders regardless of the Handled flag. |
Ongoing/Order Acknowledge
Parse a SHARK acknowledge XML document and conform each order line to Ongoing by moving the article to the specified out location.
Parameters
| Parameter |
Type |
Description |
| UserName |
TEXT |
If specified this will be the user name reported to Ongoing for the movement. |
| Password |
TEXT |
Password for the Ongoing REST API. |
| URL |
TEXT |
URL for the Ongoing REST API. |
| ToLocation |
TEXT |
The Ongoing location where the article will be moved to. |
| Debug |
BOOLEAN |
If true output additional information usefull for debugging. |
| HandleOrderID |
INTEGER |
Only orders with this OrderTypeID will be handled, others just ignored. |
| LogToSystemLog |
BOOLEAN |
Log activity to the Shark System Log. |
| MovedByUser |
TEXT |
User name reported to Ongoing. Leave empty to use the actual Shark user name or specify another name to be reported. It must be a user knowm to Ongoing. |
Ongoing/Update Article Master Data
Read Article Master Data information from Ongoing and update the SHARK article master data. Do not run this too often, it is a lengthly database heavy operation.
Parameters
| Parameter |
Type |
Description |
| UserName |
TEXT |
User for the REST authentication. |
| Password |
TEXT |
Password for REST authentication. |
| URL |
TEXT |
URL for the Ongoing SOAP service. |
| Location |
TEXT |
Location in Ongoing for filtering articles to be read. |
| MaxArticlesPerPage |
INTEGER |
The maximum number of articles read in each call (page) to the Ongoing SOAP service. SHARK will be continue calling the service until all articles are read. |
| MaxPages |
INTEGER |
The maximum numner of pages to be read. A stop rule, normally it will stop when all has been read. |
| Debug |
BOOLEAN |
Genereate additional logging. |
| UseOwner |
BOOLEAN |
Use the SHARK owner concept, when a owner is specified in Ongoing. |
| SerialNumberStrategy |
ENUMERATED |
When Ongoing specifies serial numbers are required, this is the actually strategy used in SHARK (all articles will then share the same strategy). |
| LinkToPictureInMisc2 |
BOOLEAN |
Store the Ongoing picture url in the article Misc2 field. |
| LogToSystemLog |
BOOLEAN |
Log activity to the Shark System Log. |