{"id":967,"date":"2024-07-03T14:59:14","date_gmt":"2024-07-03T13:59:14","guid":{"rendered":"https:\/\/france.magicsoftware.com\/blog\/?p=967"},"modified":"2024-09-11T14:52:55","modified_gmt":"2024-09-11T13:52:55","slug":"amazon-s3-and-magic-xpi","status":"publish","type":"post","link":"https:\/\/france.magicsoftware.com\/blog\/magic-xpi\/amazon-s3-and-magic-xpi\/","title":{"rendered":"Amazon S3 and Magic xpi"},"content":{"rendered":"\n

Goal1<\/strong> : Describe the different steps for connecting Magic xpi with Amazon S3 using a DotNet custom component<\/p>\n\n\n\n

Goal2<\/strong> : Describe general steps to develop a custom component<\/p>\n\n\n\n

Prerequisite<\/strong> : Access to Amazon S3 with AccessKey, SecretKey, Region and Endpoint URL.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Check with postman that you can have access to Amazon service<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

1\/ Copy the custom component for Amazon S3 (AmazonS3) to the <Magic xpi installation directory>\\Runtime\\addon_connectors<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n
\"\"<\/figure>\n\n\n\n

2\/ Open the Magic xpi Studio, you should see the Connector AmazonS3 in the Toolbox repository<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

3\/ Open the Magic xpi Resources repository and create an AmazonS3 resource<\/p>\n\n\n\n

Set the credentials with the amazon S3 related informations<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Click Validate, you should see a successfull message displaying the number of buckets<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

4\/ Drag and Drop the AmazonS3 connector and right click to configure it<\/p>\n\n\n\n

Catch the Store Result In<\/em> in a Blob variable and press OK<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

5\/ If you want to list Objects in a Bucket, choose the Method \u00ab\u00a0ListingObjects\u00a0\u00bb and set the Region and the BucketName<\/p>\n\n\n\n

!! For each method, you have to set all fields with a value (for empty value just enter 2 simple quotes)<\/strong><\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n
\"\"<\/figure>\n\n\n\n

6\/ Run the Flow in Debug Mode and check the result in the C.UserBlob variable.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n
\"\"<\/figure>\n\n\n\n

The response should be an Array of Amazons3Response including attributes of each object.<\/p>\n\n\n\n

7\/ The connector implements 8 methods (putfile, getobject, ListingObjects, DeleteObjects, uploadDirectory, downloadDirectory, CreateBucket, DeleteBucket<\/strong>)<\/p>\n\n\n\n

8\/ Next, i will describe the major steps to follow in other to create the connector.<\/p>\n\n\n\n

You have to develop 2 projects one for the UI used in design mode and one for the Runtime. I’ll use Dotnet technology for both of them.<\/p>\n\n\n\n

(*) you can use java for the runtime project.<\/p>\n\n\n\n

9\/ Open The connector Builder and create all the informations to create the connector skeleton.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n
\"\"<\/figure>\n\n\n\n

10\/ Open the UI project<\/strong> with Visual Studio and load these assemblies<\/p>\n\n\n\n

<Magic xpi installation>\\Studio\\Extensions\\Application (iBolt.Common.dll, MagicSoftware.Integration.UserComponents.dll) and <Magic xpi installation>\\Runtime (XPI_SDK.dll)<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n
\"\"<\/figure>\n\n\n\n

11\/ The \u00ab\u00a0ValidateResource\u00a0\u00bb method is called when you click on the Validate Button in the resource repository<\/p>\n\n\n\n

ResourceData is used to retrieve credentials from the resource repo.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Create an instance of the Amazons3 client, list the number of buckets and display a successfull message if it’s ok.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n
\"\"<\/figure>\n\n\n\n

12\/ Design the connector configuration screen.<\/p>\n\n\n\n

The method \u00ab\u00a0Configure\u00a0\u00bb is called when you right click on the connector. You have to use an MVVM model and use XAML to design the screen<\/p>\n\n\n\n

You should used a Class that implements a Magic xpi UserControl<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n
\"\"<\/figure>\n\n\n\n

In the code behind, you have to use the methods below<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

13\/ In design Mode, when you click OK on the connector, the \u00ab\u00a0GetXMLSchemaConfiguration()\u00a0\u00bb is called from \u00ab\u00a0GetSchema()\u00a0\u00bb and then the xsd file opens in the mapper<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

14\/ Build the solution and copy all files (dll, …) in the <Magic xpi installation dir>\\Runtime\\addon_connectors\\AmazonS3\\ui\\lib<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

15\/ Now Open the Runtime Project<\/strong> with Visual Studio<\/p>\n\n\n\n

In Runtime mode, \u00ab\u00a0invoke\u00a0\u00bb method is called. Payload is retrieved from the variable StepParams.PayloadOBject and the resource from StepParams.ResourceObject.TryGetValue<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Define 2 variables to catch the response and the success indication (variables \u00ab\u00a0operationSuccess\u00a0\u00bb and \u00ab\u00a0operationSuccessAmazonS3\u00a0\u00bb are retrieved from StepData Class declared in the UI project)<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n
\"\"<\/figure>\n\n\n\n

16\/ According to the received payload, call to right method from S3Client class and pass the payload and aws credentials.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n
\"\"<\/figure>\n\n\n\n

17\/ Serialize in XML the response <\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

18\/ Rebuild the solution and copy the related files into <Magic xpi directory>\\Runtime\\addon_connectors\\AmazonS3\\runtime\\dotnet\\lib<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

19\/ The Connector and source file is available here (for Magic xpi 4.14) : https:\/\/france.magicsoftware.com\/share\/amazons3.zip<\/a><\/p>\n\n\n\n

20\/ Documentation (Magic xpi Connector Builder.pdf and AWS SDK for .NET V3 API Documentation (amazon.com)<\/a>)<\/p>\n","protected":false},"excerpt":{"rendered":"

Goal1 : Describe the different steps for connecting Magic xpi with Amazon S3 using a DotNet custom component Goal2 : Describe general steps to develop a custom component Prerequisite : Access to Amazon S3 with AccessKey, SecretKey, Region and Endpoint URL. Check with postman that you can have access to Amazon service 1\/ Copy the […]<\/p>\n","protected":false},"author":1,"featured_media":969,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"site-sidebar-layout":"default","site-content-layout":"","ast-site-content-layout":"default","site-content-style":"default","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","ast-disable-related-posts":"","theme-transparent-header-meta":"","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"default","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"footnotes":""},"categories":[35,4,46],"tags":[36,14],"class_list":["post-967","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-magic-xpi-magic-xpi","category-magic-xpi","category-s3","tag-amazon-s3","tag-magic-xpi"],"aioseo_notices":[],"jetpack_featured_media_url":"https:\/\/france.magicsoftware.com\/blog\/wp-content\/uploads\/2024\/07\/AWS_S3_1.png","_links":{"self":[{"href":"https:\/\/france.magicsoftware.com\/blog\/wp-json\/wp\/v2\/posts\/967","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/france.magicsoftware.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/france.magicsoftware.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/france.magicsoftware.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/france.magicsoftware.com\/blog\/wp-json\/wp\/v2\/comments?post=967"}],"version-history":[{"count":97,"href":"https:\/\/france.magicsoftware.com\/blog\/wp-json\/wp\/v2\/posts\/967\/revisions"}],"predecessor-version":[{"id":1253,"href":"https:\/\/france.magicsoftware.com\/blog\/wp-json\/wp\/v2\/posts\/967\/revisions\/1253"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/france.magicsoftware.com\/blog\/wp-json\/wp\/v2\/media\/969"}],"wp:attachment":[{"href":"https:\/\/france.magicsoftware.com\/blog\/wp-json\/wp\/v2\/media?parent=967"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/france.magicsoftware.com\/blog\/wp-json\/wp\/v2\/categories?post=967"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/france.magicsoftware.com\/blog\/wp-json\/wp\/v2\/tags?post=967"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}