{"type":"doc","content":[{"type":"paragraph","content":[{"text":"This article describes how to develop artifacts to Link 3.","type":"text"}]},{"type":"paragraph"},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"c8e3af19-95fe-4ea5-9489-7672c19c2b52"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"e364ef9e-5f60-41d2-a981-4526bd8cd377"}},{"type":"heading","attrs":{"level":2},"content":[{"text":"Prerequisites","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Visual Studio 2022","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":".NET 6","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Visual Studio Templates","type":"text"}]},{"type":"paragraph","content":[{"text":"It is possible to get project-templates in Visual Studio 2022 supporting all Link3 artifact-types.","type":"text"}]},{"type":"paragraph","content":[{"text":"To install the templates use the following command:","type":"text"}]},{"type":"codeBlock","content":[{"text":"dotnet new install Bizbrains.Link.Templates --nuget-source https://bizbrains-productteam.pkgs.visualstudio.com/Link3Public/_packaging/Link3Public/nuget/v3/index.json","type":"text"}]},{"type":"paragraph","content":[{"text":"It’s recommended to close your running Visual Studio instances before installing the templates.","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"After installation you should be able to choose the “Link Step“ project type (search for Bizbrains):","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1021,"alt":"image-20240730-142012.png","id":"66194181-0243-436e-b974-ed27d2b786c3","collection":"contentId-2604793857","type":"file","height":274}}]},{"type":"paragraph","content":[{"text":"When creating the new project, you will be prompted to choose the type of artifact and to give your artifact a name (which will be the pre-fix for the auto-generated classes). Avoid spaces in the name.","type":"text"},{"type":"hardBreak"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":706,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":706,"alt":"image-20240730-142153.png","id":"a2cccc23-0a30-43d1-a866-a4c762d9ef67","collection":"contentId-2604793857","type":"file","height":640},"marks":[{"type":"border","attrs":{"size":1,"color":"#091e4224"}}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":" The templates contains a nuget.config file. If the nuget-dependencies can’t be resolved - move the nuget.config file to the same directory as your solution (.sln) file. Nuget.config is not supported on project-folder level.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Now you can compile the project and fill in the missing methods. Look for “TODO”'s in the code.","type":"text"}]},{"type":"paragraph"},{"type":"mediaSingle","attrs":{"layout":"center","width":383,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":383,"alt":"image-20240731-045135.png","id":"e2c97551-165d-418b-aaeb-5dcb2e3967ca","collection":"contentId-2604793857","type":"file","height":249}}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Available Visual Studio Templates","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Link Step","type":"text","marks":[{"type":"strong"}]},{"text":" – Create a new artifact using any of the available types.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Link Step Unit Test","type":"text","marks":[{"type":"strong"}]},{"text":" – Set up a unit test project to validate your artifact.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Link XSLT","type":"text","marks":[{"type":"strong"}]},{"text":" – Develop XSLT transformations to be used within Link.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Search for “Link” when creating a new project, and they should appear in the list:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":982,"alt":"image-20250401-120419.png","id":"63c23dd2-88b9-4b01-bf40-8cf2bb4e3982","collection":"contentId-2604793857","type":"file","height":327}}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Nuget","type":"text"}]},{"type":"paragraph","content":[{"text":"Nuget-packages for Link 3 are placed in a public devops project here:","type":"text"}]},{"type":"paragraph","content":[{"text":"https://bizbrains-productteam.visualstudio.com/Link3Public/_artifacts/feed/Link3Public","type":"text","marks":[{"type":"link","attrs":{"href":"https://bizbrains-productteam.visualstudio.com/Link3Public/_artifacts/feed/Link3Public"}}]}]},{"type":"paragraph","content":[{"text":"Follow the link above to see the repository and click the “Connect to Feed” button to see setup instruction for numerous different tools.","type":"text"}]},{"type":"paragraph","content":[{"text":"Create a new nuget-source in visual studio using the this link: ","type":"text"},{"text":"https://bizbrains-productteam.pkgs.visualstudio.com/Link3Public/_packaging/Link3Public/nuget/v3/index.json","type":"text","marks":[{"type":"link","attrs":{"href":"https://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fbizbrains-productteam.pkgs.visualstudio.com%2FLink3Public%2F_packaging%2FLink3Public%2Fnuget%2Fv3%2Findex.json&data=05%7C01%7Cher%40bizbrains.com%7C822231449ae949e0eef708dac8acba62%7C1d18dc41f751481c9c8a18d938ca3807%7C0%7C0%7C638042941430926726%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=dkjg%2F1Ep0SD%2Fi6WrdVrYnFTiNsZgooSns%2BsvlDNidEo%3D&reserved=0"}}]}]},{"type":"paragraph","content":[{"text":"It should look like this:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":80.0},"content":[{"type":"media","attrs":{"width":672,"id":"4c69d8b5-17a7-4779-aa1b-f675941fab20","collection":"contentId-2604793857","type":"file","height":329}}]},{"type":"paragraph","content":[{"text":"Notice! ","type":"text","marks":[{"type":"strong"}]},{"text":"At the time of writing only pre-release packages are available, so it’s necessary to check the “Include prerelease” checkbox:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":50.0},"content":[{"type":"media","attrs":{"width":534,"id":"ed877f78-94ba-4f5b-a021-b30c95f18d89","collection":"contentId-2604793857","type":"file","height":229}}]},{"type":"paragraph","content":[{"text":"Otherwise no packages will be shown.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Bizbrains.Link.Base","type":"text"}]},{"type":"paragraph","content":[{"text":"This package contains all interfaces and base-classes needed to develop Link Artifacts.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Bizbrains.Link.Base.Implementations","type":"text"}]},{"type":"paragraph","content":[{"text":"This package contains some implementations from the base-package. Eg. an implementation of ILinkMessage, Exceptions, etc. It also contains the LinkPropertyAccessor implementation, which is used to access context properties in a strongly-types way.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Bizbrains.Link.Repositories","type":"text"}]},{"type":"paragraph","content":[{"text":"Contains all the repositories in Link. These repositories can be used to communicate with the database. A repository in Link is characterized by only handling a single entity. And an entity typically represents a table in the database.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Bizbrains.Link.Services","type":"text"}]},{"type":"paragraph","content":[{"text":"Services that contains business-logic are placed in this package.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Interfaces / base classes","type":"text"}]},{"type":"paragraph","content":[{"text":"The Bizbrains.Link.Base nuget package contains all needed interfaces used to develop artifacts for Link. ","type":"text"},{"type":"hardBreak"},{"text":"Below image is a class diagram for all base interfaces and abstract base classes.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1880,"id":"7dcc976e-d45e-41e0-9745-dbc6445e72e6","collection":"contentId-2604793857","type":"file","height":926}}]},{"type":"paragraph","content":[{"text":"Typically artifacts should be implemented using the abstract base classes and not the interfaces directly. This is because the base-classes provides some “convenience functionality” which makes it easier to implement an artifact for Link. The base classes also use generics to tell the type of the configuration-class for the artifact.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Flow base-classes","type":"text"}]},{"type":"paragraph","content":[{"text":"The following list is the base-classes needed when implementing what we call “flow-steps”. Flow-steps is implementations that can be hooked in different places in the flow (see Link 3 architecture - TODO: Make architecture drawing).","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Retrieve Steps","type":"text"}]},{"type":"paragraph","content":[{"text":"Usage: (S)Ftp polling, Http polling, etc.","type":"text"},{"type":"hardBreak"},{"text":"Base class: TransportRetrieveBase","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Initialize Steps","type":"text"}]},{"type":"paragraph","content":[{"text":"Usage: Pre-disassembler, disassembler, post-disassembler","type":"text"},{"type":"hardBreak"},{"text":"Base class: InitializeStepBase","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Itinerary Steps","type":"text"}]},{"type":"paragraph","content":[{"text":"Usage: Transformation, validation, all kind of logic (previously implemented in Biztalk Pipelines)","type":"text"},{"type":"hardBreak"},{"text":"Base class: ItineraryStepBase2","type":"text"},{"type":"hardBreak"},{"text":"Note: The original ItineraryStepBase has been flagged as Obsolete and will be removed in the future, so it is important to use the new base class.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Send Steps","type":"text"}]},{"type":"paragraph","content":[{"text":"Usage: All kind of transport","type":"text"},{"type":"hardBreak"},{"text":"Base class: TransportSendBase","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Outbox Steps","type":"text"}]},{"type":"paragraph","content":[{"text":"Usage: Used to place documents in outbox","type":"text"},{"type":"hardBreak"},{"text":"Base class: TransportOutboxBase","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Duplicate Check Steps","type":"text"}]},{"type":"paragraph","content":[{"text":"Usage: Selects a specific value from the payload that the duplicate check framework should run against as part of the Initialize flow.","type":"text"},{"type":"hardBreak"},{"text":"Base class: DuplicateCheckBase2","type":"text"}]},{"type":"paragraph","content":[{"text":"Note: The original DuplicateCheckBase has been flagged as Obsolete and will be removed in the future, so it is important to use the new base class.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Format Type Probe Steps","type":"text"}]},{"type":"paragraph","content":[{"text":"Usage: Validates that the payload format is of a specific type. E.g. XML","type":"text"},{"type":"hardBreak"},{"text":"Base class: LinkFormatTypeProbeBase2","type":"text"}]},{"type":"paragraph","content":[{"text":"Note: The original LinkFormatTypeProbeBase has been flagged as Obsolete and will be removed in the future, so it is important to use the new base class.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"HttpHandler Steps","type":"text"}]},{"type":"paragraph","content":[{"text":"Usage: Use this to expose any kind of functionality for an HTTP endpoint. This could be a custom API, a webhook, or even a website.","type":"text"},{"type":"hardBreak"},{"text":"Base class: LinkHttpHandlerBase2","type":"text"}]},{"type":"paragraph","content":[{"text":"Note: The original LinkHttpHandlerBase has been flagged as Obsolete and will be removed in the future, so it is important to use the new base class.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Test Tool base-classes","type":"text"}]},{"type":"paragraph","content":[{"text":"The following list is the base-classes used for the test tool.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Compare Plugin","type":"text"}]},{"type":"paragraph","content":[{"text":"Usage: Have two responsibilities. ","type":"text"},{"type":"hardBreak"},{"text":"First is to prepare the stream for comparison. This could be based on the config of the plugin. Example is to handle ID’s or timestamps that are generated on run time.","type":"text"},{"type":"hardBreak"},{"text":"Second is to compare the two streams.","type":"text"}]},{"type":"paragraph","content":[{"text":"Base class: TestToolCompareBase","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Tracking Action base-classes","type":"text"}]},{"type":"paragraph","content":[{"text":"The following is the base-class used for tracking actions.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Tracking UI Action","type":"text"}]},{"type":"paragraph","content":[{"text":"Usage: Have two responsibilities. ","type":"text"},{"type":"hardBreak"},{"text":"First is to validate the selected document or documents. Documents that are not in a final state will automatically be rejected, but the plugin can also reject documents based on its own requirements.","type":"text"},{"type":"hardBreak"},{"text":"Second is to perform the actual action, which is also entirely up to the plugin.","type":"text"}]},{"type":"paragraph","content":[{"text":"The base class take two configuration classes. The first is for static configuration, that is configured when the button is configured; the second is runtime configuration, which the user will supply when activating the button.","type":"text"}]},{"type":"paragraph","content":[{"text":"Base class: TrackingActionBase","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Dependency Injection","type":"text"}]},{"type":"paragraph","content":[{"text":"In Link 3 we use dependency injection. This means that we will always work on interfaces and not on the actual implementations. Therefore you will find that only interfaces, entities and models are public in our code.","type":"text"}]},{"type":"paragraph","content":[{"text":"If you are not familiar with dependency injection, it’s highly recommended that you get some basic knowledge before developing artifacts for Link 3.","type":"text"}]},{"type":"paragraph","content":[{"text":"You can find some information here: ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://docs.microsoft.com/en-us/dotnet/core/extensions/dependency-injection"}},{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"ILinkStep registration","type":"text"}]},{"type":"paragraph","content":[{"text":"All classes that implement (or derive from classes that implement) ILinkStep must be registered with DI as transient services. To ensure backwards compatibility, any such class that is registered as a scoped service is automatically (and silently) changed to a transient service. Any attempt to register an ILinkStep as a singleton results in an exception being thrown.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Singletons","type":"text"}]},{"type":"paragraph","content":[{"text":"While it is possible to register any service class, except ILinkStep’s, as a singleton, it is not supported and should be avoided because it will cause memory leaks and eventually containers will crash and restart.","type":"text","marks":[{"type":"em"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Context properties","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Note that only simple types in the value-field are supported (string, int, double, bool, etc.). ","type":"text"}]},{"type":"paragraph","content":[{"text":"If complex types are added to the property-bag it will most likely throw an exception, when the message is serialized to the queue.","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"LinkPropertyAccessor","type":"text"}]},{"type":"paragraph","content":[{"text":"The LinkPropertyAccessor is used to access context-properties in a strongly-typed way. The constructor of the LinkPropeLinkPropertyAccessor takes an ILinkMessage or an ILinkPropertyBag, and then you can access all known properties in Link.This is a replacement for the xml-schemas used in Biztalk and Link 2.","type":"text"}]},{"type":"paragraph","content":[{"text":"The accessor provides methods for getting and setting values in context-properties without knowing the namespace and key for the property. It also provides methods for getting a value, which must exist - and throws a well-defined exception if the property doesn’t exist.","type":"text"}]},{"type":"paragraph","content":[{"text":"Example code:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"var accessor = new LinkPropertyAccessor(linkMessage);\n// Optional use of property\nif (accessor.PartnerIn.IdentificationValue.HasValue)\n{\n var partnerInIdentification = accessor.PartnerIn.IdentificationValue.Value;\n // Do what's needed...\n}\n\n// Set context-property:\naccessor.PartnerIn.IdentificationValue.Value = \"123456789\";\naccessor.PartnerIn.IdentificationQualifier.Value = \"GLN\";\n\n// Mandatory use of property\nvar partnerInIdentification = accessor.PartnerIn.IdentificationValue.ValueMandatory; // This will throw an exception if the distribution-id has not been set","type":"text"}]},{"type":"paragraph","content":[{"text":"See code examples to see more code.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Custom context properties","type":"text"}]},{"type":"paragraph","content":[{"text":"Via the ILinkPropertyBag it’s possible to add and maintain custom context-properties. There is no accessor for maintaining these properties, so you must cast the value yourself or use the generic-typed method.","type":"text"}]},{"type":"paragraph","content":[{"text":"Example code:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"var propertyBag = linkMessage.Properties;\n\n// Set custom property\npropertyBag.Add(\"MyProperty\", \"http://mycompany/link/myproperty\", \"MyPropertyValue\");\n// or\npropertyBag[\"MyProperty\", \"http://mycompany/link/myproperty\", false] = \"MyPropertyValue\";\n\n// Get value\nvar myValue = (string)propertyBag[\"MyProperty\", \"http://mycompany/link/myproperty\"];\n// or\nvar myvalue = propertyBag.GetValue(\"MyProperty\", \"http://mycompany/link/myproperty\");","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Readonly properties","type":"text"}]},{"type":"paragraph","content":[{"text":"The ILinkPropertyBag offers the possibility of setting readonly properties. This means that the property can only be set once - and after that it’s immutable across the entire flow.","type":"text"}]},{"type":"paragraph","content":[{"text":"Example code:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"var propertyBag = linkMessage.Properties;\n\n// Set readonly property\npropertyBag[\"MyProperty\", \"http://mycompany/link/myproperty\", true] = \"MyPropertyValue\";\n\n// Try setting it again - will result in an exception of type LinkPropertyBagReadOnlyFieldException:\npropertyBag[\"MyProperty\", \"http://mycompany/link/myproperty\", false] = \"MyPropertyValue\";","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Artifact Configuration Classes","type":"text"}]},{"type":"paragraph","content":[{"text":"Artifacts can via configuration-classes expose properties that will be reflected in the Link UI.","type":"text"}]},{"type":"paragraph","content":[{"text":"So if your artifacts for example needs an URL which is required that the users types in, when configuring your artifact, you can simply create a property-class with an URL property inside.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Should I use LinkConfigBase or ILinkConfig?","type":"text"}]},{"type":"paragraph","content":[{"text":"The artifact configuration-framework contains two types of configurations:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Artifacts that support retries","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Use the LinkConfigBase as your base class","type":"text"},{"type":"hardBreak"},{"text":"The areas that support retries are: Initialize, Itinerary and Send","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Artifacts that doesn’t support retries","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Use the ILinkConfig as your base class/interface","type":"text"},{"type":"hardBreak"},{"text":"The areas for this is Retrieve steps","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Configuration attributes","type":"text"}]},{"type":"paragraph","content":[{"text":"There is a set of attributes, which can be used to control the apperance of the properties. See list below.","type":"text"}]},{"type":"layoutSection","content":[{"type":"layoutColumn","attrs":{"width":50.0},"content":[{"type":"heading","attrs":{"level":4},"content":[{"text":"LinkDisplay","type":"text"}]},{"type":"expand","attrs":{"title":"Show properties"},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Name (The label of the presentation-field)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Description (The tooltip of the presentation-field)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Order (The order inside the group)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"GroupName (The name of the presentation-group which this fields belongs to. If blank it will be set to “Settings”)","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"LinkStringLength","type":"text"}]},{"type":"expand","attrs":{"title":"Show properties"},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MaximumLength (The maximum length of the input-field)","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"LinkRequired","type":"text"}]},{"type":"expand","attrs":{"title":"Show properties"},"content":[{"type":"paragraph","content":[{"text":"No properties","type":"text"}]},{"type":"paragraph","content":[{"text":"Mark the presentation-field as required","type":"text"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"LinkRegularExpression","type":"text"}]},{"type":"expand","attrs":{"title":"Show properties"},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Pattern (The regular expression used on the input-field)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ErrorMessage (The message to show if the pattern doesn’t match the inputted value)","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"LinkDependsOn","type":"text"}]},{"type":"expand","attrs":{"title":"Show properties"},"content":[{"type":"paragraph","content":[{"text":"This attribute can be used, if some properties depends on the value chosen in other properties. If the Value of the given PropertyName doesn’t match, the presentation-field will be hidden for the user - and all other validation for the field will be disabled.","type":"text"}]},{"type":"paragraph","content":[{"text":"Properties:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"PropertyName (The name of the property this field is dependant of. Use the nameof keyword to get the name of the property instead of providing a string)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"PropertyValues (The values that will make the field show in the UI)","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"LinkArray","type":"text"}]},{"type":"expand","attrs":{"title":"Show properties"},"content":[{"type":"paragraph","content":[{"text":"This attribute can be used to show an dynamic list of elements. These elements can consist of multiple fields and are defined in code as a class with a number of properties decorated with ","type":"text"},{"text":"Link*","type":"text","marks":[{"type":"em"}]},{"text":" attributes. E.g. ","type":"text"},{"text":"LinkDisplay","type":"text","marks":[{"type":"em"}]},{"text":", ","type":"text"},{"text":"LinkRequired","type":"text","marks":[{"type":"em"}]},{"text":"… ","type":"text"}]},{"type":"paragraph","content":[{"text":"Properties:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MinElements (The minimum number of items this array ","type":"text"},{"text":"should","type":"text","marks":[{"type":"strong"}]},{"text":" hold)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MaxElements (The maximum number of items this array ","type":"text"},{"text":"can","type":"text","marks":[{"type":"strong"}]},{"text":" hold)","type":"text"}]}]}]}]}]},{"type":"layoutColumn","attrs":{"width":50.0},"content":[{"type":"heading","attrs":{"level":4},"content":[{"text":"LinkDefaultValue","type":"text"}]},{"type":"expand","attrs":{"title":"Show properties"},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Value (The default value of the presentation-field)","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"LinkPassword","type":"text"}]},{"type":"expand","attrs":{"title":"Show properties"},"content":[{"type":"paragraph","content":[{"text":"No properties","type":"text"}]},{"type":"paragraph","content":[{"text":"Shows the presentation-field as a password-field","type":"text"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"LinkArtifactAssembly","type":"text"}]},{"type":"expand","attrs":{"title":"Show properties"},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"AssemblyType (The type of the assembly to choose: TransportRetrieve, TransportSend, ItineraryStep, InitStep, Dependency, IntegratedFtpProvider)","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"LinkArtifactXml","type":"text"}]},{"type":"expand","attrs":{"title":"Show properties"},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"XmlType (The type of the xml to choose: Schema, Xslt)","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"LinkEnum","type":"text"}]},{"type":"expand","attrs":{"title":"Show properties"},"content":[{"type":"paragraph","content":[{"text":"This attribute can only be set on enum-fields.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"DisplayName (The name to show in the dropdown. The value will remain the enum-field-name)","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"LinkChoice","type":"text"}]},{"type":"expand","attrs":{"title":"Show properties"},"content":[{"type":"paragraph","content":[{"text":"This attribute can be used to show a dropdown with dynamic values. Instead of using the enum-type, it’s here possible runtime to create a list of choices that can populated in a dropdown.","type":"text"}]},{"type":"paragraph","content":[{"text":"Properties:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"IConfigAttributeChoiceServiceType (The type of the implementation that provides the key/value pairs to show in the dropdown. The given type must implement the IConfigAttributeChoiceService interface)","type":"text"}]}]}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Code example","type":"text"}]},{"type":"paragraph","content":[{"text":"The following code shows different way of using the attributes:","type":"text"}]},{"type":"expand","attrs":{"title":"Show code"},"content":[{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"public class HTTPStepConfig : LinkConfigBase\n{\n [LinkRequired]\n [LinkDefaultValue(nameof(RestCommands.POST))]\n [LinkDisplay(Name = \"REST Command\", Description = \"\", GroupName = \"HTTP Settings\", Order = 10)]\n public RestCommands RestCommand { get; set; }\n\n [LinkRequired]\n [LinkDisplay(Name = \"Endpoint URL\", Description = \"\", GroupName = \"HTTP Settings\", Order = 11)]\n public string EndpointUrl { get; set; }\n\n [LinkDisplay(Name = \"Header: Content-Type\", Description = \"\", GroupName = \"HTTP Settings\", Order = 12)]\n public string ContentType { get; set; }\n\n [LinkDisplay(Name = \"Header: Accept\", Description = \"\", GroupName = \"HTTP Settings\", Order = 13)]\n public string Accept { get; set; }\n\n [LinkRequired]\n [LinkDisplay(Name = \"Connection Timeout\", Description = \"\", GroupName = \"HTTP Settings\", Order = 14)]\n [LinkDefaultValue(\"30\")]\n public int? Timeout { get; set; }\n\n [LinkRequired]\n [LinkDefaultValue(nameof(AuthenticationType.Basic))]\n [LinkDisplay(Name = \"Authentication Type\", Description = \"\", GroupName = \"HTTP Settings - Authentication\", Order = 20)]\n public AuthenticationType AuthenticationTypes { get; set; }\n\n [LinkRequired]\n [LinkDisplay(Name = \"Username\", Description = \"\", GroupName = \"HTTP Settings - Authentication\", Order = 21)]\n [LinkDependsOn(nameof(AuthenticationTypes), nameof(AuthenticationType.Basic))]\n public string BasicUsername { get; set; }\n\n [LinkRequired]\n [LinkPassword]\n [LinkDisplay(Name = \"Password\", Description = \"\", GroupName = \"HTTP Settings - Authentication\", Order = 22)]\n [LinkDependsOn(nameof(AuthenticationTypes), nameof(AuthenticationType.Basic))]\n public string BasicPassword { get; set; }\n\n [LinkRequired]\n [LinkDisplay(Name = \"Api Key\", Description = \"\", GroupName = \"HTTP Settings - Authentication\", Order = 25)]\n [LinkDependsOn(nameof(AuthenticationTypes), nameof(AuthenticationType.ApiKey))]\n public string ApiKeyName { get; set; }\n\n [LinkRequired]\n [LinkDisplay(Name = \"Api Key Value\", Description = \"\", GroupName = \"HTTP Settings - Authentication\", Order = 26)]\n [LinkDependsOn(nameof(AuthenticationTypes), nameof(AuthenticationType.ApiKey))]\n public string ApiKeyValue { get; set; }\n\n [LinkDisplay(Name = \"Api Key in URL\", Description = \"If checked the Api Key will be in the URI instead of the headers\", GroupName = \"HTTP Settings - Authentication\", Order = 27)]\n [LinkDependsOn(nameof(AuthenticationTypes), nameof(AuthenticationType.ApiKey))]\n public bool ApiSetKeyInUri { get; set; }\n}","type":"text"}]}]},{"type":"paragraph","content":[{"text":"The above will result in the following UI when used in a TransportSend implementation:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1140,"id":"5f44f4b4-c97f-4bf7-8463-2972a24bc21e","collection":"contentId-2604793857","type":"file","height":559}}]},{"type":"paragraph","content":[{"text":"The group “General” is generated because the configuration class inherits from LinkConfigBase, which have these properties.","type":"text","marks":[{"type":"em"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"LinkChoice attribute - populate dynamic values runtime","type":"text"}]},{"type":"paragraph","content":[{"text":"This attribute can be used to show a dropdown with dynamic values. Instead of using the enum-type, it’s here possible runtime to create a list of choices that can populated in a dropdown.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Examples of usage:","type":"text"}]},{"type":"paragraph","content":[{"text":"Simple static list of choices:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"public class MyItineraryStepConfig : LinkConfigBase \n{\n [LinkChoice(typeof(MyConfigService))] // Set the type that implements the IConfigAttributeChoiceService interface\n public string MyChoice { get; set; }\n}\n\n// Implementation of the IConfigAttributeChoiceService interface that just returnes a list of static values\npublic class MyConfigService : IConfigAttributeChoiceService\n{\n public Task> GetChoices(LinkChoiceAttribute attribute)\n {\n var choices = new List();\n choices.Add(new ConfigAttributeChoiceItem { Key = \"1\", DisplayName = \"Item 1\" });\n choices.Add(new ConfigAttributeChoiceItem { Key = \"2\", DisplayName = \"Item 2\" });\n choices.Add(new ConfigAttributeChoiceItem { Key = \"3\", DisplayName = \"Item 3\" });\n choices.Add(new ConfigAttributeChoiceItem { Key = \"4\", DisplayName = \"Item 4\" });\n choices.Add(new ConfigAttributeChoiceItem { Key = \"5\", DisplayName = \"Item 5\" });\n choices.Add(new ConfigAttributeChoiceItem { Key = \"6\", DisplayName = \"Item 6\" });\n\n return Task.FromResult(choices.AsEnumerable());\n }\n}","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Use a service to provide choices:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"public class MyItineraryStepConfig : LinkConfigBase \n{\n [LinkDisplay(Name = \"Partner\")]\n [LinkChoice(typeof(MyConfigPartnerService))]\n public int PartnerId { get; set; }\n}\n\n// Implementation of the IConfigAttributeChoiceService interface that loads all partners and convert them to choices\npublic class MyConfigPartnerService : IConfigAttributeChoiceService\n{\n private readonly IPartnerSearchRepository partnerRepository;\n\n public MyConfigPartnerService(IPartnerSearchRepository partnerRepository) // Inject the partner-search-repository\n {\n this.partnerRepository = partnerRepository;\n }\n\n public async Task> GetChoices()\n {\n // Load all partners\n var partners = await partnerRepository.Search(DataAccessRestrictionMode.None, \"\", false);\n // Convert partners to choice-items with the partner-id as key and a concatenation of the partner-name and main-identification as display name.\n var choices = partners.PartnerSearchEntities.Select(p => new ConfigAttributChoiceItem { Key = p.Id.ToString(), DisplayName = $\"{p.Name} ({p.MainIdentificationName}: {p.MainIdentificationValue})\" });\n return choices;\n }\n}","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Call an external service to provide choices:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"public class MyItineraryStepConfig : LinkConfigBase \n{\n [LinkDisplay(Name = \"Products\")]\n [LinkChoice(typeof(MyConfigExternalService))]\n public int ProductId { get; set; }\n}\n\n// Implementation of the IConfigAttributeChoiceService interface that loads a list of products from an external service\npublic class MyConfigExternalService : IConfigAttributeChoiceService\n{\n public MyConfigExternalService() { }\n\n public async Task> GetChoices()\n {\n var client = new HttpClient();\n var result = await client.GetAsync(\"https://dummyjson.com/products\");\n var jsonStream = await result.Content.ReadAsStreamAsync();\n var productResult = await JsonSerializer.DeserializeAsync(jsonStream);\n var choices = productResult.Products.Select(p => new ConfigAttributChoiceItem { Key = p.Id.ToString(), DisplayName = $\"{p.Title} ({p.Price})\" });\n return choices;\n }\n\n private class ProductResult\n {\n [JsonPropertyName(\"products\")]\n public Product[] Products { get; set; }\n }\n\n private class Product\n {\n [JsonPropertyName(\"id\")]\n public int Id { get; set; }\n [JsonPropertyName(\"title\")]\n public string Title { get; set; }\n [JsonPropertyName(\"price\")]\n public double Price { get; set; }\n }\n}","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"text":"LinkArray attribute","type":"text"}]},{"type":"paragraph","content":[{"text":"This attribute can be used to show a list of elements consisting of one or more fields. The user is allowed to add or remove elements. The number of elements can be restricted in code using the ","type":"text"},{"text":"MinElements ","type":"text","marks":[{"type":"em"}]},{"text":"and ","type":"text"},{"text":"MaxElements ","type":"text","marks":[{"type":"em"}]},{"text":"properties. ","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Examples of usage:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"public class MyItineraryStepConfig : LinkConfigBase \n{\n [LinkArray(MinElements = 1, MaxElements = 4)]\n [LinkDisplay(Name = \"Custom data\", Description = \"Some custom data\", GroupName = \"My Settings\", Order = 1)]\n public MyCustomData[] CustomData { get; set; }\n}\n\npublic class MyCustomData\n{\n [LinkRequired]\n [LinkDisplay(Name = \"Name\", Description = \"Custom prop 1\", Order = 1)]\n public string Name { get; set; }\n\n [LinkDisplay(Name = \"Value\", Description = \"Custom prop 2\", Order = 2)]\n public int Value { get; set; }\n \n [LinkArtifactXml(ArtifactXmlType.Schema, XmlType = ArtifactXmlType.Schema)]\n [LinkDisplay(Name = \"Schema\", Description = \"Custom prop 3\", Order = 3)]\n public Guid Schema { get; set; }\n}","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"StepKeyName","type":"text"}]},{"type":"paragraph","content":[{"text":"All steps in Link inherits from the ILinkStep interface. And this interface has two properties:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ConfigType","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"StepKeyName","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"The ConfigType is the type of the configuration-object. This is typically implemented as a generic type in a derived base-class. Like: TransportRetrieveBase where T will be set as the ConfigType via the base-class.","type":"text"}]},{"type":"paragraph","content":[{"text":"The StepKeyName is a string and must be a unique representation of the step. There are no validation of the name, but we highly recommend to use a standard way of naming your step.","type":"text"}]},{"type":"paragraph","content":[{"text":"For steps that are going via the MessageBroker (ItinerarySteps and SendTransportSteps) this name is used as the queue-name on the message-broker. Therefore it must be unique, so scaling can be done based on the steps.","type":"text"}]},{"type":"paragraph","content":[{"text":"Link comes with some system-artifacts, and the StepKeyName for these artifacts are prefixed with: “system-”. See ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://bizbrains.atlassian.net/wiki/spaces/PT/pages/2408579160"}},{"text":" for more information about this.","type":"text"}]},{"type":"paragraph","content":[{"text":"For custom steps we recommend the following convention (all in lower-case):","type":"text"}]},{"type":"paragraph","content":[{"text":"“customer-area-subarea-logic”","type":"text"}]},{"type":"paragraph","content":[{"text":"Customer","type":"text","marks":[{"type":"strong"}]},{"text":": ","type":"text"},{"type":"hardBreak"},{"text":"The name of the company that has developed the step","type":"text"}]},{"type":"paragraph","content":[{"text":"Area","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"},{"type":"hardBreak"},{"text":"This could be: “initialize”, “itinerary”, “transport”","type":"text"}]},{"type":"paragraph","content":[{"text":"Subarea","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"},{"type":"hardBreak"},{"text":"This might not always be necessary, but for transport-types it could be: “retrieve”, “send”, “outbox”","type":"text"}]},{"type":"paragraph","content":[{"text":"Logic","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"This is a value that represents the logic for the step. Be so specific as possible to prevent collision with other steps. Examples: “xml-validation”, “xslt-transform”, “split-payload”, etc. (TODO: Find better examples).","type":"text"}]},{"type":"paragraph","content":[{"text":"Complete examples:","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"“bizbrains-initialize-xml-disassembler”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"“microsoft-itinerary-edifact”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"“apple-transport-send-to-icloud”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"“amazon-transport-retrieve-from-webservices”","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"ILinkFactory and LinkFactoryBase","type":"text"}]},{"type":"paragraph","content":[{"text":"All artifacts in Link 3 have the responsibility for creating the instance of the ILinkStep they implement.","type":"text"}]},{"type":"paragraph","content":[{"text":"This is done via the LinkFactoryBase base class which implement the ILinkFactory interface.","type":"text"}]},{"type":"paragraph","content":[{"text":"Example of an LinkFactoryBase usage:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"public class MyItineraryStepFactory : LinkStepFactoryBase\n{\n public override void ConfigureServices(IServiceCollection serviceCollection)\n {\n // We add our step to the service-collection, because dependency injection will then resolve any services, repositories, logging and other stuff we expect in our constructor\n serviceCollection.AddTransient();\n // Add additional services, if you have any...\n }\n\n public override ILinkItineraryStep Create(IServiceProvider serviceProvider)\n {\n return serviceProvider.GetRequiredService();\n }\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Logging","type":"text"}]},{"type":"paragraph","content":[{"text":"All logging in artifacts are done via the ILogger interface, which is part of Microsoft.Extensions.Logging.","type":"text"}]},{"type":"paragraph","content":[{"text":"To get an ILogger just put it in your constructor, and the dependency-injection will make sure you get an instance. Remember to use the type-specific ILogger and not the generic ILogger interface.","type":"text"}]},{"type":"paragraph","content":[{"text":"Required packages:","type":"text","marks":[{"type":"strong"}]},{"text":" Microsoft.Extensions.Logging","type":"text"}]},{"type":"paragraph","content":[{"text":"Add ","type":"text"},{"text":"serviceCollection.AddLogging();","type":"text","marks":[{"type":"code"}]},{"text":" in ConfigureServices(IServiceCollection serviceCollection) Method.","type":"text"}]},{"type":"codeBlock","content":[{"text":"public class MyItineraryStep : ItineraryStepBase2\n{\n private readonly ILogger logger;\n\n public MyItineraryStep(ILogger logger)\n {\n this.logger = logger;\n }\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Cancellation token","type":"text"}]},{"type":"paragraph","content":[{"text":"Cancellation tokens provide a graceful way to signal to the underlying framework that it needs to stop what it is doing. This could, for example, be because the system is shutting down. This gives you control over how you want you code to stop, even if it hasn’t finished it’s task, which can be particularly useful in situations where your code could end up being long running.","type":"text"}]},{"type":"paragraph","content":[{"text":"Many of our interfaces have methods that take a cancellation token. By default cancellation tokens are checked immediately before the actual implementation of an artifact is executed.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Error handling","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"LinkExceptionBase","type":"text"}]},{"type":"paragraph","content":[{"text":"In Link 3 there is a base exception class, that should be used: LinkExceptionBase","type":"text"},{"type":"hardBreak"},{"text":"By using this exception it’s possible to give an error-code, so the error will be routed to the right stakeholder in the error handling engine.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"LinkFlowException","type":"text"}]},{"type":"paragraph","content":[{"text":"For steps running in an engine that supports retry (Itinerary and Send) - it’s possible to control the behavior of the retry-mechanism by throwing this exception.","type":"text"}]},{"type":"paragraph","content":[{"text":"LinkFlowException supports stopping the retry, if it doesn’t make sense to retry. Eg. validation - if the document fails in validation, it will also fail when retrying. ","type":"text"}]},{"type":"codeBlock","content":[{"text":"throw new LinkFlowException(\"Validation error\", *******, retryAllowed: false);","type":"text"}]},{"type":"paragraph","content":[{"text":"It’s also possible to give the document a specific status - eg. Ignored if this is needed:","type":"text"}]},{"type":"codeBlock","content":[{"text":"throw new LinkFlowException(\"Validation error\", *******, documentStatus: \"Ignored\", retryAllowed: false);","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Link Services and Repositories","type":"text"}]},{"type":"paragraph","content":[{"text":"In Link 3 there are different layers of services. ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Repositories","type":"text"}]},{"type":"paragraph","content":[{"text":"The lowest layer is what we call repositories. A repository communicates with the database and takes or returns entities (like Partners, Distributions, etc.). ","type":"text"}]},{"type":"paragraph","content":[{"text":"In Link 2 and below we provide nested entities via the “Common” layer. Eg. a Distribution contains full Partner objects - and the Partner objects contains full Identification objects - and so on.","type":"text"}]},{"type":"paragraph","content":[{"text":"This is changed in Link 3. ","type":"text"},{"text":"An entity has only one level of properties - and no complex types are allowed on these entities.","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"This means that if you have a distribution-id and want to lookup details on one of the partners, you need to first load the DistributionEntity via the IDistributionRepository, then you need to load the PartnerEntity via the IPartnerRepository based on the partner-id on the distribution.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Services","type":"text"}]},{"type":"paragraph","content":[{"text":"Services are a higher level than repositories, and services typically provides some kind of business-logic. ","type":"text"},{"type":"hardBreak"},{"text":"Eg. we consider all itinerary-, send-, polling-, etc.- steps as services, because they each represents some business logic.","type":"text"}]},{"type":"paragraph","content":[{"text":"Link 3 also comes with some centralized helper-services. These services can be found in the Bizbrains.Link.Services package. (TODO: Create a list of typically used services).","type":"text"}]},{"type":"paragraph"},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"As everything in Link 3 each repository and service is available through an interface and not the direct implementation.","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Code examples","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Retrieve Steps","type":"text"}]},{"type":"paragraph","content":[{"text":"The following example is a RetrieveStep that downloads the content of the configured Url and save it to Inbox.","type":"text"}]},{"type":"paragraph","content":[{"text":"Used base class: ","type":"text","marks":[{"type":"strong"}]},{"text":"TransportRetrieveBase","type":"text"},{"type":"hardBreak"},{"text":"Required packages","type":"text","marks":[{"type":"strong"}]},{"text":": Bizbrains.Link.Base, Bizbrains.Link.Base.Implementations, Bizbrains.Link.Services","type":"text"}]},{"type":"expand","attrs":{"title":"Show code"},"content":[{"type":"codeBlock","content":[{"text":"using Bizbrains.Link.Base;\nusing Bizbrains.Link.Base.ConfigAttributes;\nusing Bizbrains.Link.Services.Transaction.Tracking;\nusing Microsoft.Extensions.DependencyInjection;\nusing Microsoft.Extensions.Logging;\n\nnamespace Link.Examples.Retrieve\n{\n public class MyRetrieveStepFactory : LinkStepFactoryBase\n {\n public override string StepDisplayName => \"My http retrieve\";\n\n public override string StepDescription => \"Retrieves a payload from the configured Url.\";\n\n public override void ConfigureServices(IServiceCollection serviceCollection)\n {\n serviceCollection.AddTransient();\n }\n\n public override ILinkTransportRetrieve Create(IServiceProvider serviceProvider)\n {\n return serviceProvider.GetRequiredService();\n }\n }\n\n public class MyRetrieveStep : TransportRetrieveBase\n {\n private readonly ILogger logger;\n private readonly ILinkMessageFactory linkMessageFactory;\n\n public MyRetrieveStep(ILogger logger, ILinkMessageFactory linkMessageFactory)\n {\n this.logger = logger;\n this.linkMessageFactory = linkMessageFactory;\n }\n\n public override string StepKeyName => \"bizbrains-transport-retrieve-myretrieve\";\n\n protected override string GenerateDisplayAddress(MyRetrieveStepConfig config)\n {\n return \"MyRetriever\";\n }\n\n protected override async Task Retrieve(ILinkRetrieveProvider retrieveProvider, MyRetrieveStepConfig config, CancellationToken ct)\n {\n var httpClient = new HttpClient();\n var httpRequest = new HttpRequestMessage(HttpMethod.Get, config.Url);\n\n logger.LogInformation($\"Calling {config.Url}\");\n var response = await httpClient.SendAsync(httpRequest, ct);\n logger.LogInformation(\"Http call done - reading response...\");\n\n var body = await response.Content.ReadAsStreamAsync();\n\n logger.LogInformation($\"Response read. Length: {body.Length}. Creating LinkMessage...\");\n var linkMessage = await linkMessageFactory.CreateMessage(body);\n\n logger.LogInformation(\"LinkMessage created. Save the message in Inbox\");\n await retrieveProvider.SaveToInbox(linkMessage, new LinkRetrieveAdditionalInfo { FileName = \"MyHttpResponse.txt\" });\n }\n }\n\n public class MyRetrieveStepConfig : ILinkConfig\n {\n [LinkRequired]\n [LinkDisplay(Name = \"Url\", GroupName = \"Http\", Order = 1)]\n public string Url { get; set; }\n }\n}","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Initialize Steps","type":"text"}]},{"type":"paragraph","content":[{"text":"The following code is an example of an artifact implementing the InitializeStepBase base class. it is just a simple passthrough:","type":"text"}]},{"type":"paragraph","content":[{"text":"Used base class:","type":"text","marks":[{"type":"strong"}]},{"text":" InitializeStepBase","type":"text"}]},{"type":"paragraph","content":[{"text":"Required packages:","type":"text","marks":[{"type":"strong"}]},{"text":" Bizbrains.Link.Base, Bizbrains.Link.Base.Implementations","type":"text"}]},{"type":"expand","attrs":{"title":""},"content":[{"type":"codeBlock","content":[{"text":"using Bizbrains.Link.Base;\nusing Bizbrains.Link.Services.Transaction.Tracking;\nusing Microsoft.Extensions.DependencyInjection;\n\nnamespace Bizbrains.Link.Initialize.InitializeSteps.Xml\n{\n public class XmlDisassemblerFactory : LinkStepFactoryBase\n {\n public override string StepDisplayName => \"Custom InitStep Xml Disassembler\";\n\n public override string StepDescription => \"Custom Xml disassembler\";\n\n public override void ConfigureServices(IServiceCollection serviceCollection)\n {\n serviceCollection.AddTransient();\n base.ConfigureServices(serviceCollection);\n }\n\n public override ILinkInitializeStep Create(IServiceProvider serviceProvider)\n {\n return serviceProvider.GetRequiredService();\n }\n }\n\n public class XmlDisassembler : InitializeStepBase\n {\n private readonly ILinkMessageFactory linkMessageFactory;\n\n public override string StepKeyName => \"Custom-initialize-xml\";\n\n public XmlDisassembler(ILinkMessageFactory linkMessageFactory)\n {\n this.linkMessageFactory = linkMessageFactory;\n }\n\n public override async Task> Process(ILinkMessage message, XmlDisassemblerConfig config, CancellationToken cancellationToken)\n {\n return new List() { await linkMessageFactory.CreateXmlMessage(message.Body.Data, message.Properties) };\n }\n }\n}\n","type":"text"}]},{"type":"paragraph"},{"type":"paragraph"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Itinerary Steps","type":"text"}]},{"type":"paragraph","content":[{"text":"The following code is an example of an artifact implementing the ItineraryStepBase2 base class. The step can take an XPath and evaluate it against the payload, and promote the value to the configured property-namespace and property-name.","type":"text"}]},{"type":"paragraph","content":[{"text":"Used base class","type":"text","marks":[{"type":"strong"}]},{"text":": ItineraryStepBase2","type":"text"},{"type":"hardBreak"},{"text":"Required packages","type":"text","marks":[{"type":"strong"}]},{"text":": Bizbrains.Link.Base","type":"text"}]},{"type":"expand","attrs":{"title":"Show code"},"content":[{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"using Bizbrains.Link.Base;\nusing Bizbrains.Link.Base.ConfigAttributes;\nusing Bizbrains.Link.Base.Exceptions;\nusing Microsoft.Extensions.DependencyInjection;\nusing Microsoft.Extensions.Logging;\nusing System.Xml.Linq;\nusing System.Xml.XPath;\n\nnamespace Link.Examples.ItineraryStep\n{\n public class MyItineraryStepFactory : LinkStepFactoryBase\n {\n public override string StepDisplayName => \"My itinerary step\";\n public override string StepDescription => \"This step extracts a value from an XPath and promotes the value to context-properties.\";\n public override void ConfigureServices(IServiceCollection serviceCollection)\n {\n // We add our step to the service-collection, because dependency injection will then resolve any services, repositories, logging and other stuff we expect in our constructor\n serviceCollection.AddTransient();\n // Add additional services, if you have any...\n }\n\n public const string ErrorCodeXPath = \"AHREU\"; // Generate the error-code in the Link UI (Developer -> Error codes -> Generate code)\n public const string ErrorCodeUnexpectedError = \"01W7K\";\n public override IEnumerable RegisterErrorCodes()\n {\n var errorCodes = new List();\n errorCodes.Add(new LinkErrorCode(ErrorCodeXPath, LinkExceptionTypeArea.Itinerary, LinkExceptionCategory.MissingConfigurationError, \"MyItinerary\", \"XPath doesnt' return any element.\", \"Contact developer\"));\n errorCodes.Add(new LinkErrorCode(ErrorCodeUnexpectedError, LinkExceptionTypeArea.Itinerary, LinkExceptionCategory.UnexpectedError, \"MyItinerary\", \"Something went wrong during the XPath promotion. This payload might not be valid XML.\", \"Verify that the payload is valid XML\"));\n return base.RegisterErrorCodes();\n }\n\n public override ILinkItineraryStep2 Create(IServiceProvider serviceProvider)\n {\n return serviceProvider.GetRequiredService();\n }\n }\n\n public class MyItineraryStep : ItineraryStepBase2\n {\n private readonly ILogger logger;\n\n public MyItineraryStep(ILogger logger)\n {\n this.logger = logger;\n }\n\n public override string StepKeyName => \"bizbrains-itinerary-mystep\";\n\n protected override Task Execute(ILinkMessage linkMessage, MyItineraryStepConfig config, CancellationToken cancellationToken)\n {\n logger.LogInformation($\"Calling execute on {GetType()}\");\n try\n {\n var xDocument = XDocument.Load(linkMessage.Body.Data);\n var xElement = xDocument.XPathSelectElement(config.PromotionXpath) ?? throw new LinkException($\"The XPath {config.PromotionXpath} doesn't return any elements.\", MyItineraryStepFactory.ErrorCodeXPath);\n\n linkMessage.Properties.Add(config.PromotionPropertyName, config.PromotionPropertyNamespace, xElement.Value); // Promote the value of the xpath to the given namespace and name\n linkMessage.Body.Data.Seek(0, SeekOrigin.Begin); // Remember to rewind the body-stream\n\n logger.LogInformation(\"All done!\");\n }\n catch(Exception ex)\n {\n throw new LinkException(\"Something went wrong during the XPath promotion. This payload might not be valid XML.\", MyItineraryStepFactory.ErrorCodeUnexpectedError, innerException: ex);\n }\n\n return Task.FromResult(linkMessage);\n }\n }\n\n public class MyItineraryStepConfig : LinkConfigBase\n {\n [LinkRequired]\n [LinkDisplay(Name = \"XPath\", GroupName = \"XPath promotion\", Description = \"The XPath used to retrieve the value that should be promoted\", Order = 1)]\n public string PromotionXpath { get; set; }\n [LinkRequired]\n [LinkDisplay(Name = \"Context Property Namespace\", GroupName = \"XPath promotion\", Order = 2)]\n public string PromotionPropertyNamespace { get; set; }\n [LinkRequired]\n [LinkDisplay(Name = \"Context Property Key\", GroupName = \"XPath promotion\", Order = 3)]\n public string PromotionPropertyName { get; set; }\n }\n}","type":"text"}]},{"type":"paragraph"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"The following example does not do anything with the payload. It’s just to show how to use repositories to lookup entities.","type":"text"}]},{"type":"paragraph","content":[{"text":"Used base class: ","type":"text","marks":[{"type":"strong"}]},{"text":"ItineraryStepBase2","type":"text"},{"type":"hardBreak"},{"text":"Required packages","type":"text","marks":[{"type":"strong"}]},{"text":": Bizbrains.Link.Base, Bizbrains.Link.Base.Implementations, Bizbrains.Link.Repositories","type":"text"}]},{"type":"expand","attrs":{"title":"Show code"},"content":[{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"using Bizbrains.Link.Base;\nusing Bizbrains.Link.Base.Implementations.MessageProperties;\nusing Bizbrains.Link.Repositories.Configuration.DistributionModel;\nusing Bizbrains.Link.Repositories.Configuration.Partner;\nusing Microsoft.Extensions.DependencyInjection;\nusing Microsoft.Extensions.Logging;\n\nnamespace Bizbrains.Examples.ItineraryStep2\n{\n public class MyItineraryStepFactory : LinkStepFactoryBase\n {\n public override string StepDisplayName => \"My itinerary step\";\n\n public override string StepDescription => \"This step does nothing but logging some info...\";\n public override void ConfigureServices(IServiceCollection serviceCollection)\n {\n // We add our step to the service-collection, because dependency injection will then resolve any services, repositories, logging and other stuff we expect in our constructor\n serviceCollection.AddTransient();\n // Add additional services, if you have any...\n }\n\n public override ILinkItineraryStep2 Create(IServiceProvider serviceProvider)\n {\n return serviceProvider.GetRequiredService();\n }\n }\n\n public class MyItineraryStep : ItineraryStepBase2\n {\n private readonly ILogger logger;\n private readonly IDistributionRepository distributionRepository;\n private readonly IPartnerRepository partnerRepository;\n\n public MyItineraryStep(ILogger logger, IDistributionRepository distributionRepository, IPartnerRepository partnerRepository)\n {\n this.logger = logger;\n this.distributionRepository = distributionRepository;\n this.partnerRepository = partnerRepository;\n }\n\n public override string StepKeyName => \"bizbrains-itinerary-mystep\";\n\n protected override async Task Execute(ILinkMessage linkMessage, MyItineraryStepConfig config, CancellationToken cancellationToken)\n {\n // Access context-properties\n var accessor = new LinkPropertyAccessor(linkMessage);\n var distributionId = accessor.Distribution.Id.ValueMandatory; // ValueMandatory will throw an exception with a telling text about the property and the missing value.\n\n // Load distribution-entity\n var distributionEntity = await distributionRepository.GetById(distributionId, false);\n logger.LogInformation($\"Distribution details - PartnerInId: {distributionEntity.PartnerInId}, PartnerOutId: {distributionEntity.PartnerOutId}\");\n\n // Load sender-partner-entity\n var senderPartner = await partnerRepository.GetById(accessor.PartnerIn.Id.ValueMandatory);\n logger.LogInformation($\"Sender partner-name: {senderPartner.Name}\");\n\n return linkMessage;\n }\n }\n\n public class MyItineraryStepConfig : LinkConfigBase { }\n}","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Send Steps","type":"text"}]},{"type":"paragraph","content":[{"text":"The following example shows how to implement a send-step. This step takes the body of the ILinkMessage and transmits it over Http. The configuration-class provides the Url and the Http Verb.","type":"text"}]},{"type":"paragraph","content":[{"text":"Used base class","type":"text","marks":[{"type":"strong"}]},{"text":": TransportSendBase","type":"text"},{"type":"hardBreak"},{"text":"Required packages","type":"text","marks":[{"type":"strong"}]},{"text":": Bizbrains.Link.Base","type":"text"}]},{"type":"expand","attrs":{"title":"Show code"},"content":[{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"using Bizbrains.Link.Base;\nusing Bizbrains.Link.Base.ConfigAttributes;\nusing Microsoft.Extensions.DependencyInjection;\nusing Microsoft.Extensions.Logging;\n\nnamespace Link.Examples.SendStep\n{\n public class MySendStepFactory : LinkStepFactoryBase\n {\n public override string StepDisplayName => \"My Http Sender\";\n\n public override string StepDescription => \"This step will post the body of the LinkMessage to the configured http-address\";\n public override void ConfigureServices(IServiceCollection serviceCollection)\n {\n // We add our step to the service-collection, because dependency injection will then resolve any services, repositories, logging and other stuff we expect in our constructor\n serviceCollection.AddTransient();\n // Add additional services, if you have any...\n }\n\n public override ILinkTransportSend Create(IServiceProvider serviceProvider)\n {\n return serviceProvider.GetRequiredService();\n }\n }\n\n public class MySendStep : TransportSendBase\n {\n private readonly ILogger logger;\n\n public MySendStep(ILogger logger)\n {\n this.logger = logger;\n }\n\n public override string StepKeyName => \"bizbrains-transport-send-httpsender\";\n\n protected override string GenerateDisplayAddress(MySendStepConfig config)\n {\n // The display-address is used when creating the transport-type in Link.\n // Then this method will be invoked, and you can put together whatever makes sense for your transport-type.\n return $\"{config.Url} ({config.HttpVerb})\";\n }\n\n protected override async Task Send(ILinkMessage linkMessage, ILinkSendProvider sendProvider, MySendStepConfig config, CancellationToken ct)\n {\n var httpClient = new HttpClient();\n var httpMethod = config.HttpVerb == HttpVerb.Put ? HttpMethod.Put : HttpMethod.Post;\n var httpRequest = new HttpRequestMessage(httpMethod, config.Url);\n httpRequest.Content = new StreamContent(linkMessage.Body.Data);\n\n logger.LogInformation($\"Calling {config.Url} ({config.HttpVerb})\");\n var response = await httpClient.SendAsync(httpRequest, ct);\n logger.LogInformation(\"Http call done - reading response...\");\n\n var body = await response.Content.ReadAsStreamAsync();\n\n logger.LogInformation($\"Response read. Length: {body.Length}. Setting body on LinkMessage...\");\n linkMessage.SetBody(body);\n }\n }\n\n public class MySendStepConfig : LinkConfigBase\n {\n [LinkRequired]\n [LinkDisplay(Name = \"Url\", GroupName = \"Http\", Order = 1)]\n public string Url { get; set; }\n\n [LinkRequired]\n [LinkDisplay(Name = \"Http method\", GroupName = \"Http\", Order = 2)]\n [LinkDefaultValue(nameof(HttpVerb.Post))]\n public HttpVerb HttpVerb { get; set; } // Enums will be presented as dropdowns\n }\n\n public enum HttpVerb\n {\n // Use the LinkEnum attribute to put a display-name on an enum.\n [LinkEnum(\"Post method\")]\n Post,\n [LinkEnum(\"Put method\")]\n Put\n }\n}","type":"text"}]}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Duplicate Check Steps","type":"text"}]},{"type":"paragraph","content":[{"text":"The following example shows how to implement a duplicate check step. This step finds a specific value in the body of the ILinkMessage and returns it. The configuration-class provides the from and to position of the desired value in the paylod.","type":"text"}]},{"type":"paragraph","content":[{"text":"Used base class","type":"text","marks":[{"type":"strong"}]},{"text":": DuplicateCheckBase2","type":"text"},{"type":"hardBreak"},{"text":"Required packages","type":"text","marks":[{"type":"strong"}]},{"text":": Bizbrains.Link.Base","type":"text"}]},{"type":"expand","attrs":{"title":"Show code"},"content":[{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"using Bizbrains.Link.Base;\nusing Bizbrains.Link.Base.ConfigAttributes;\nusing Bizbrains.Link.Base.DuplicateCheck;\nusing Microsoft.Extensions.DependencyInjection;\nusing Microsoft.Extensions.Logging;\n\nnamespace Link.Examples.DuplicateCheck\n{\n public class MyDuplicateCheckFactory : LinkStepFactoryBase\n {\n public override string StepDisplayName => \"My Duplicate Check\";\n\n public override string StepDescription => \"Finds a value in the payload at a specific position to use in the duplicate check framework\";\n\n public override void ConfigureServices(IServiceCollection serviceCollection)\n {\n // We add our step to the service-collection, because dependency injection will then resolve any services, repositories, logging and other stuff we expect in our constructor\n serviceCollection.AddTransient();\n // Add additional services, if you have any...\n }\n\n public override ILinkDuplicateCheck2 Create(IServiceProvider serviceProvider)\n {\n return serviceProvider.GetRequiredService();\n }\n }\n\n internal class MyDuplicateCheck : DuplicateCheckBase2\n {\n private readonly ILogger logger;\n\n public MyDuplicateCheck(ILogger logger)\n {\n this.logger = logger;\n }\n\n public override DuplicateCheckType DuplicateCheckType => DuplicateCheckType.Interchange;\n\n public override string StepKeyName => \"bizbrains-duplicate-check-myduplicatecheck\";\n\n protected override Task GetDuplicateCheckValue(ILinkMessage message, MyDuplicateCheckConfig config, CancellationToken cancellationToken)\n {\n logger.LogInformation(\"Starting MyDuplicateCheck\");\n\n var reader = new StreamReader(message.Body.Data);\n var payload = reader.ReadToEnd();\n\n // Find the value based on the position specified in the config.\n var payloadValue = payload[config.PositionFrom..config.PositionTo];\n\n // Remember to rewind the body-stream\n message.Body.Data.Seek(0, SeekOrigin.Begin);\n\n var result = new DuplicateCheckResult()\n {\n CheckValue = payloadValue\n };\n\n logger.LogInformation(\"Finished MyDuplicateCheck\");\n return Task.FromResult(result);\n }\n }\n\n public class MyDuplicateCheckConfig : ILinkConfig\n {\n [LinkRequired]\n [LinkDisplay(Name = \"Position from\", GroupName = \"MyDuplicateCheck Config\", Description = \"Starting position of value in payload\", Order = 1)]\n public int PositionFrom { get; set; }\n\n [LinkRequired]\n [LinkDisplay(Name = \"Position to\", GroupName = \"MyDuplicateCheck Config\", Description = \"Ending position of value in payload\", Order = 2)]\n public int PositionTo { get; set; }\n }\n}","type":"text"}]}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Format Type Probe","type":"text"}]},{"type":"paragraph","content":[{"text":"The following example shows how to implement a Format Type prober.","type":"text"}]},{"type":"paragraph","content":[{"text":"Used base class","type":"text","marks":[{"type":"strong"}]},{"text":": LinkFormatTypeProbeBase2","type":"text"},{"type":"hardBreak"},{"text":"Required packages","type":"text","marks":[{"type":"strong"}]},{"text":": Bizbrains.Link.Base, Bizbrains.Link.Base.Implementations","type":"text"}]},{"type":"expand","attrs":{"title":"Show code"},"content":[{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"using Bizbrains.Link.Base;\nusing Bizbrains.Link.Base.ConfigAttributes;\nusing Bizbrains.Link.Base.Exceptions;\nusing Bizbrains.Link.Base.Implementations;\nusing Microsoft.Extensions.DependencyInjection;\nusing Microsoft.Extensions.Logging;\nusing System.Text;\n\nnamespace Link.Examples.FormatTypeProbe\n{\n public class MyFormatProbeFactory : LinkStepFactoryBase\n {\n public override string StepDisplayName => \"MyFormat Probe\";\n\n public override string StepDescription => \"Checks if the paylod is of type MyFormat\";\n\n public override void ConfigureServices(IServiceCollection serviceCollection)\n {\n // We add our step to the service-collection, because dependency injection will then resolve any services, repositories, logging and other stuff we expect in our constructor\n serviceCollection.AddTransient();\n // Add additional services, if you have any...\n }\n\n public override ILinkFormatTypeProbe2 Create(IServiceProvider serviceProvider)\n {\n return serviceProvider.GetRequiredService();\n }\n\n public const string MySettingInvalidError = \"A1B2C\"; // Generate the error-code in the Link UI (Developer -> Error codes -> Generate code)\n public override IEnumerable RegisterErrorCodes()\n {\n var errorCodes = new List();\n errorCodes.Add(new LinkErrorCode(MySettingInvalidError, LinkExceptionTypeArea.Initialize, LinkExceptionCategory.MissingConfigurationError, \"MyFormatProbe\", \"Configuration field MySetting contains an invalid value\", \"Only use valid values\"));\n return base.RegisterErrorCodes();\n }\n }\n\n internal class MyFormatProbe : LinkFormatTypeProbeBase2\n {\n private readonly ILogger logger;\n\n public MyFormatProbe(ILogger logger)\n {\n this.logger = logger;\n }\n\n public override Task Probe(Stream payload, Encoding encoding, MyFormatProbeConfig config, CancellationToken cancellationToken)\n {\n try\n {\n logger.LogInformation(\"Probing for MyFormat\");\n\n //Implement logic for checking if payload is of type MyFormat\n\n if (config.MySetting != \"ValidValue\")\n {\n throw new LinkException($\"The value \\\"{config.MySetting}\\\" is not a valid value for field MySetting\", MyFormatProbeFactory.MySettingInvalidError);\n }\n\n return Task.FromResult(true);\n }\n catch (Exception)\n {\n return Task.FromResult(false);\n }\n }\n }\n\n public class MyFormatProbeConfig : LinkConfigBase\n {\n [LinkRequired]\n [LinkDisplay(Name = \"MySetting\", GroupName = \"MyFormat Config\", Description = \"Used for probing MyFormat\", Order = 1)]\n public string MySetting { get; set; }\n }\n}","type":"text"}]}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Compare Plugin","type":"text"}]},{"type":"paragraph","content":[{"text":"The following example shows how to implement a Compare Plugin.","type":"text"}]},{"type":"paragraph","content":[{"text":"Used base class","type":"text","marks":[{"type":"strong"}]},{"text":": TestToolCompareBase","type":"text"},{"type":"hardBreak"},{"text":"Required packages","type":"text","marks":[{"type":"strong"}]},{"text":": Bizbrains.Link.Base","type":"text"}]},{"type":"expand","attrs":{"title":"Show code"},"content":[{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"using Bizbrains.Link.Base;\nusing Bizbrains.Link.Base.ConfigAttributes;\nusing Bizbrains.Link.Base.TestTool;\nusing Microsoft.Extensions.DependencyInjection;\nusing Microsoft.Extensions.Logging;\nusing System.Text;\nusing System.Xml;\nusing System.Xml.Linq;\n\nnamespace Link.Examples.Compare\n{\n public class MyXmlCompareFactory : LinkFactoryBase\n {\n public override void ConfigureServices(IServiceCollection serviceCollection)\n {\n serviceCollection.AddTransient();\n }\n\n public override ITestToolCompare Create(IServiceProvider serviceProvider)\n {\n return serviceProvider.GetRequiredService();\n }\n }\n\n public class MyXmlCompare : TestToolCompareBase\n {\n private readonly ILogger logger;\n public override string StepKeyName => \"bizbrains-testtool-myxmlcompare\";\n\n public MyXmlCompare(ILogger logger)\n {\n this.logger = logger;\n }\n\n public override Task Compare(TestToolDocumentContainer documentContainer, CancellationToken cancellationToken)\n {\n TestToolResult result = new TestToolResult();\n List errors = new List();\n //\n //Convert incomming streams to more easily handled objects.\n //\n\n cancellationToken.ThrowIfCancellationRequested();\n\n //\n //Iterate through xml documents and compare element by element\n //\n\n result.Errors = errors;\n\n if (errors.Count > 0)\n {\n result.Success = false;\n }\n else\n {\n result.Success = true;\n }\n return Task.FromResult(result);\n }\n\n public override Task Prepare(TestToolDocumentContainer documentContainer, MyXmlCompareConfig config, CancellationToken cancellationToken)\n {\n //\n //Convert incomming streams to more easily handled objects.\n //\n\n cancellationToken.ThrowIfCancellationRequested();\n\n //\n //Prepare both streams based on config. could be removing nodes or changing data so they will compare(like date time objects that will always be different.\n //\n\n //\n // Convert manipulated objects back to streams and return them\n //\n\n TestToolDocumentContainer resultContainer = new TestToolDocumentContainer();\n resultContainer.OriginalDocument = StringToStream(xmlDoc1.OuterXml, documentContainer.OriginalDocumentEncoding);\n resultContainer.OriginalDocumentEncoding = documentContainer.OriginalDocumentEncoding;\n resultContainer.TestDocument = StringToStream(xmlDoc2.OuterXml, documentContainer.TestDocumentEncoding);\n resultContainer.TestDocumentEncoding = documentContainer.TestDocumentEncoding;\n\n return Task.FromResult(resultContainer);\n }\n\n\n private static Stream StringToStream(string src, Encoding encoding)\n {\n byte[] byteArray = encoding.GetBytes(src);\n return new MemoryStream(byteArray);\n }\n }\n\n\n\n public class MyXmlCompareConfig : ILinkConfig\n {\n [LinkDisplay(Name = \"Xpath\", GroupName = \"Xpath 1\", Order = 10)]\n public string Xpath1 { get; set; } = \"\";\n\n [LinkDefaultValue(nameof(PrepareConfig.Ignore))]\n [LinkDisplay(Name = \"Xpath Action\", Description = \"What to do with this xpath. Either remove the node or set the content to fixed value that will compare\", GroupName = \"Xpath 1\", Order = 11)]\n public PrepareConfig PrepareConfig1 { get; set; }\n\n [LinkDisplay(Name = \"Xpath\", GroupName = \"Xpath 2\", Order = 20)]\n public string Xpath2 { get; set; } = \"\";\n\n [LinkDefaultValue(nameof(PrepareConfig.Ignore))]\n [LinkDisplay(Name = \"Xpath Action\", Description = \"What to do with this xpath. Either remove the node or set the content to fixed value that will compare\", GroupName = \"Xpath 2\", Order = 21)]\n public PrepareConfig PrepareConfig2 { get; set; }\n\n\n }\n\n\n public enum PrepareConfig\n {\n Ignore,\n Remove\n }\n}","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Document Type Classifier Resolver Plugin","type":"text"}]},{"type":"paragraph","content":[{"text":"The following example shows how to implement a Document Type Classifier Resolver Plugin.","type":"text"}]},{"type":"paragraph","content":[{"text":"Used base class","type":"text","marks":[{"type":"strong"}]},{"text":": DocumentTypeClassifierResolverBase2","type":"text"},{"type":"hardBreak"},{"text":"Required packages","type":"text","marks":[{"type":"strong"}]},{"text":": Bizbrains.Link.Base","type":"text"}]},{"type":"expand","attrs":{"title":"Show code"},"content":[{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"using Bizbrains.Link.Base;\nusing Bizbrains.Link.Base.DocumentTypeClassifierResolver;\nusing Microsoft.Extensions.DependencyInjection;\n\nnamespace Bizbrains.Link.SystemArtifacts.DocumentTypeClassifierResolvers.My;\n\npublic class MyDocumentTypeClassifierResolverFactory : LinkStepFactoryBase\n{\n public override string StepDisplayName => \"Bizbrains Document Type Classifier Resolver My\";\n\n public override string StepDescription => \"Document Type Classifier Resolver plugin for MY documents\";\n\n public override ILinkDocumentTypeClassifierResolver2 Create(IServiceProvider serviceProvider) => serviceProvider.GetRequiredService();\n\n public override void ConfigureServices(IServiceCollection serviceCollection)\n {\n base.ConfigureServices(serviceCollection);\n serviceCollection.AddTransient();\n }\n}\n\npublic class MyDocumentTypeClassifierResolver : DocumentTypeClassifierResolverBase2\n{\n public override string StepKeyName => \"system-document-type-classifier-resolver-my\";\n\n protected override async Task Resolve(ILinkMessage message, IEnumerable configurations, CancellationToken cancellationToken)\n {\n await Task.CompletedTask;\n\n var messageType = \"MyMessageType\";\n return new DocumentTypeClassifierResolverResult() { Result = configurations.FirstOrDefault(c => c.MessageType == messageType) };\n }\n}\n\npublic class MyDocumentTypeClassifierResolverConfig : ILinkConfig\n{\n public string MessageType { get; set; }\n}\n","type":"text"}]},{"type":"paragraph"}]}],"version":1}

Browser not supported