Changes affecting Web Services in MRI Evolution release 6.0.1.0



JIRA Ref Work Item Type Web Service Change Details DTO Value(s)
CE-1267 Story Contact Service V3 New fields added to the ContactDto Dto:
  • ExternalController
  • ClientId
ExternalController, ClientId
CE-2581 Story Contract Service V3 New field added to set behaviour when Tasks are created in a 'Triage Only' Contract. TriageFailLOCId
CE-2688 Story Contract Service V3 New field added to set behaviour when Tasks are created in a 'Triage Only' Contract. DefaultLOCId
CE-2816 Story Finance Setup Service V3 New fields added to the CostCodeDto Dto:
  • ShortDescription
  • GroupingCode
  • ScheduleReference
  • ChargeType
  • ApprovalType
  • ReportingCategory
ShortDescription, GroupingCode, ScheduleReference, ChargeType, ApprovalType, ReportingCategory
CE-2821 Story Finance Setup Service V3 New field added to the CostCentreDto Dto:
  • ShortDescription
ShortDescription
CE-1692 Story Instruction Service New field added to the InstructionDto Dto:
  • CISApplicable
Enum options - 0 = No, 1 = Yes, 2 = Referral
CISApplicable
CE-663 Story Messaging Service New Dto for Messages. New standard web methods added to the Messaging Service:
  • GetMessagesByDto
  • GetMessageById
  • UpdateMessage
  • CreateMessage
MessageId, Subject, ObjectId, MessageTypeId, MessageType (ReadOnly field showing the MessageType.BindingText of the MessageType associated with the Message), MessageText, LoggedDate, DueDate, CompletedDate, Status, AccountId, Priority, ExpiresUtc, IsSystem, LinkURL
CE-1263 Story Property Service V3 New fields added to the BuildingDto Dto:
  • ExternalController
  • ClientId
  • AltExtIdentifier
  • COBieIFCProjectId
ExternalController, ClientId, AltExtIdentifier, COBieIFCProjectId
CE-1264 Story Property Service V3 New fields added to the LocationDto Dto:
  • GrossArea
  • ExternalController
  • AltExtIdentifier
GrossArea, ExternalController, AltExtIdentifier
CE-1266 Story Property Service V3 New fields added to the SiteDto Dto:
  • Description
  • ExtSystem
  • ExtObject
  • ExtIdentifier
  • AltExtIdentifier
  • ExternalController
Description, ExtSystem, ExtObject, ExtIdentifier, AltExtIdentifier, ExternalController
CE-2650 Story Property Service V3 New field added to the LocationDto Dto:
  • StockIssueRequiresApproval
StockIssueRequiresApproval
CE-1269 Story Resource Service V3 New fields added to the ResourceDto Dto:
  • IntegrationSystem
  • IntegrationObject
  • IntegrationIdentifier
  • ExternalController
  • IntegrationDate
IntegrationSystem, IntegrationObject, IntegrationIdentifier, ExternalController, IntegrationDate
CE-1681 Story Stock Service V3 New web method added to the StockServiceV3 web service:
  • RequestStock

A new Custom Web Method has been added to the StockServiceV3 web service that can be used to create a Stock Issue Header and Item within a single request.

The logic for this new web method is similar to the existing methods for CreateStockIssueHeader and CreateStockIssueItem. The key differences with this new method are as follows:

  • The method should be able to create a Header (F_STK_TRNS_HEAD) and Line items (F_STK_TRANS) as part of a single request

  • The Response DTO reflects the Status of the F_STK_TRNS_HEAD header based on whether the request requires approval prior to issue

Web Method Logic

  1. Create a StockIssueHeader

  2. Create StockIssueItems

    1. Refer to Stock Batches to determine how many Items need to be created based on the Requested QTY

  3. If autoIssue = True then set StockIssueHeader state as Issued, bypass all approval checks

Response DTO

All MRI Evolution validation messages for F_STK_TRNS_HEAD and F_STK_TRANS should apply.

The method will return a fault code message if the user tries to request more stock than is available in the location. Same message as MRI Evolution.

 
CE-2125 Story Stock Service V3 New fields added:
  • Stock Keeping Unit Code
  • Universal Product Code
  • Colour
  • Status - Foreign key to States
  • Reorder Unit Name - The unit that describes how the product is reordered when replenishment or POs are raised e.g. Pack
  • Reorder Unit Conversion - A number that converts the Reorder base unit/QTY to the Held/ReceivedQty. For example if an item was reordered in Boxes that contained 5 Packs, this value would be 5. Receiving 1 Pack whould result in the Stock Held QTY increasing by 5
State Model added:
  • Active
  • Suspended
  • History
SKU, UPC, Colour, StateId, ReorderUnitName, ReorderUnitConversion
CE-2387 Story Stock Service V3 New fields added to the StockIssueHeaderDtoV3 Dto:
  • StateId
  • Requester
  • ResourceId
  • ApprovedBy
  • ApprovalDate
  • IssuedBy
  • CollectionDate
  • CostCentre
  • CostCode
  • ResourceName
  • ResourceGoId
  • ApproverName
  • IssuerName
StateId, Requester, ResourceId, ApprovedBy, ApprovalDate, IssuedBy, CollectionDate, CostCentre, CostCode, ResourceName, ResourceGoId, ApproverName, IssuerName
CE-2388 Story Stock Service V3 Standard web methods for the StockIssueItemDtoV3 have been added to the Stock Service V3 web service:
  • GetStockIssueItemsByDto
  • GetStockIssueItemById
  • UpdateStockIssueItem
New Web Service Permissions The methods should be controlled by new web service Allow securables in the Stock Securable Group: Retrieve Stock Issue Items
  • Controls use of GetStockIssueItemsByDto and GetStockIssueItemById
Update Stock Issue Item
  • Controls use of UpdateStockIssueItem
 
CE-2655 Story Stock Service V3 New fields added to the StockIssueHeaderDtoV3 Dto:
  • Location
  • LocationId
Location, LocationId
CE-2693 Story Stock Service V3 New field added to the StockLocationResources Dto:
  • IsApprover
IsApprover
CE-2747 Story Stock Service V3 New web method added to the StockServiceV3 web service:
  • ApproveOrRejectMobileStockRequest
This method will be used by the Evolution Go Tasks activity so that mobile Resources can Approve or Reject Stock Issue requests when other mobile Resources want to use Stock Items from their vans (Mobile Location).

Logic

The method supports determining whether Approval is possible based on the ResourceId of the mobile Resource:
  • Get the ResourceId parameter
  • Get the StockLocationResources of the current ResourceId where IsApprover = True
  • Check if the StockLocationResources assigned to the Resource match the LocationId of the F_STK_TRNS_HEAD
If the Resource is set as an Approver for the Stock Location then the state transition will be permitted. If the Resource is NOT set as an Approver for the Stock Location then the state transition will NOT be permitted and the web method will receive the following message:
  • “This stock issue request requires approval but this Resource has not been set up to approve or issue requests from this stock location. You will need to get approval from an authorised person before this issue request can proceed”
Approval Actions
  • Change the StateId of the F_STK_TRNS_HEAD to Approved
  • Create an Event against the F_STK_TRNS_HEAD for the State Transition. Comments for the Event should be set using the RES_NAME of the F_RESOURCE record determined by the ResourceId Parameter and the Comments passed in the web method parameter, in the following format:
    • “Stock Issue Request Approved by “{F_RESOURCE.RES_NAME}
    • {Comments}
Rejection Actions
  • Change the StateId of the F_STK_TRNS_HEAD to Cancelled
  • Create an Event against the F_STK_TRNS_HEAD for the State Transition. Comments for the Event should be set using the RES_NAME of the F_RESOURCE record determined by the ResourceId Parameter and the Comments passed in the web method parameter, in the following format
    • “Stock Issue Request Rejected by “{F_RESOURCE.RES_NAME}
    • {Comments}

Response

“Success” or, if failing, any appropriate validation messages
 
CE-2748 Story Stock Service V3 New StockLocationAccountDto Dto added. New web methods for the StockLocationAccountDto added to the StockServiceV3 web service:
  • GetStockLocationAccountLinksByDto
  • GetStockLocationAccountLinkById
  • UpdateStockLocationAccountLink
  • CreateStockLocationAccountLink
  • DeleteStockLocationAccountLink
The methods are controlled by a new web service Allow securable in the FSI Go Securable Group:
  • Retrieve Stock Location Account Links
    • Controls use of GetStockLocationAccountLinksByDto and GetStockLocationAccountLinkById
  • Update Stock Location Account Link
    • Controls use of UpdateStockLocationAccountLink
  • Create Stock Location Account Link
    • Controls use of CreateStockLocationAccountLink
  • Delete Stock Location Account Link
    • Controls use of DeleteStockLocationAccountLink
LocationAccountsId, AccountId, LocationId, IsApprover
CE-2941 Story Stock Service V3 The validation check in the service method for creating F_STK_TRNS_HEAD records to ensure the linked Task has a Cost Centre and Cost Code has been removed. It is now possible to create Stock Issue headers linked to any Tasks, not just those that have Cost Centres and Cost Codes.  
CE-2601 Story Stock Service V3 New web method added to the StockServiceV3 web service:
  • ReturnStock
A new web method that makes it possible to return Stock to a different Stock Location than the one the Stock has been Issued from. This method will be used by the Evolution GO Tasks activity so that mobile Resources can allocate unused issued stock to their vans (Mobile Location). The new web method will invoke similar business logic as an existing web method called ReturnStockIssueItemByIssueItemID. The main differences between the existing web method and the new method are as follows:
  • Supports moving returned Stock to a different Location
  • Allows passing a PartCode* as a parameter instead of the StockIssueItemId to identify the Stock Item that is being returned. This change is required so that the application calling the web service does not have to work out whether the original Stock Issue request resulted in multiple Stock Issue lines due to the FIFO model of creating Stock Batches
* Note: PartCode in the Dto is the name that’s been given to the primary key of the FSTOCK item, i.e. STK_SEQ and should not be confused with the actual ‘Part Code’ field for the FSTOCK item, that is NOT the STK_SEQ.
 
CE-2064 Story Task Service V3 New field added to the TaskDto Dto:
  • CISApplicable
Enum options - 0 = No, 1 = Yes, 2 = Referral
CISApplicable