Nithin Mahesh さんのグループアクティビティ

Authenticating in OAuth 2.0 with Aras RESTful API

Nithin Mahesh — Wed, 28 Feb 2029 14:23:00 GMT

In our previous blogs posts we covered a range of topics on setting up REST calls, including querying part data, adding filters for more complex queries, and calling server-side methods. Since those posts Aras Innovator has changed quite a bit and in a good way.

For one we have updated the use of OAuth 2.0, promoting improved security practices for Aras Innovator 14+ versions. In this blog post we will be covering the steps to authenticate with the server and how to run requests.

Note: we will be using Postman in this post, but any API platform will work to send the same requests.

Authenticating

Before we get to the fun stuff we will need to authenticate our requests. Go ahead and open up Postman then create a new Collection workspace.

Give the new workspace a name, such as 14+ AuthServer Requests
Click on the Authentication tab on the workspace
In the dropdown select OAuth 2.0
Click Edit token configuration then scroll down to the bottom of this page to Configure New token
Set the Configuration Options to the following:
Specifically ensure the following fields are input correctly. Use the following values for the Callback URL, Auth URL, Access Token URL, and Scope
1. Callback URL: http://<servername>/<web alias>/Client/OAuth/PopupCallback
2. Auth URL: http://<servername>/<web alias>/oauthserver/connect/authorize
3. Access Token URL: http://<servername>/<web alias>/oauthserver/connect/token
4. Scope: openid Innovator offline_access
Once you have filled all of those values in, click the Get New Access Token button at the bottom left and log into the popup Aras Innovator window with your credentials
If you log in correctly you will get another popup window with the access token. Within this window click Use Token.
Now be sure to hit the Save button on the top right corner before proceeding to any next steps

Now you have officially completed authentication we can move on to the fun part, adding a query request!

Setting up GET requests for Part data

For the purposes of this blog post we will keep our query simple in order to confirm that we have authenticated our token correctly and can reach the Aras Innovator server endpoint. If you are looking for more complex query examples check out our other blog posts on RESTful API provided at the end of this post.

Now lets take a look at a simple query to grab all the Part data from Aras Innovator:

Right click on the Meatballs Menu on the left hand side on your 14+ AuthServer Requests workspace and select Add Request
Give the request a name, something like Part Request
Click over to the Authorization tab and in the Type drop-down select Inherit auth from parent
Make sure the request is a GET then in the Enter request URL field input the following URL: http://<servername>/<web alias>/Server/Odata/Part
Go ahead and hit Send to run the request
You should start seeing the return JSON with all the parts within your database:

If you are seeing the following screen you have successfully gotten data back from the server!

Conclusion

Congrats, you have learned how to authenticate in Aras Innovator 14+ versions using Postman workspaces (allowing you to create multiple requests using the same authentication tokens). Thanks for following along!

Check out prior blog posts for more complex queries (e.g. POST calls, filtering, and method calls): Using the Aras RESTful API, Complex Filters with the Aras RESTful API, and Server Side Methods with the Aras RESTful API. Note that these blog posts were created on older versions of Aras Innovator (12 SP18 and below) so they will require you to authenticate differently. However, the same calls will work with OAuth 2.0 if you are querying from 14+ versions of Aras Innovator.

File checkout (using fetchFileProperty & checkout) not working in custom user with custom identity. how to checkout file in for user not having administrator permissions ?

Former Member — Wed, 13 Nov 2019 05:31:28 GMT

I'm trying to checkout a file using item method fetchFileProperty in custom user with custom identity which do not have administrator permission. Aras gets hang after this method call, also tried with file.checkout methods behaviour is same. With admin user file checkout with same code is working but not for different user.

What is the issue ? is this due to permissions ? what permissions needed to checkout file?

New Responsive Forms Features: An Overview

Nithin Mahesh — Thu, 25 Jan 2024 21:22:00 GMT

Experience a better way of using Aras Innovator^® with our latest updates to low-code customization features! One feature introduced recently in Release 28 is adding a responsive form design editor that utilizes a more intuitive, easy-to-use interface.

Admins can now define a container-based layout with the ability to drag and drop structural elements and fields. In this example, we will go through a quick tutorial on setting up a Responsive Form on an ItemType of your choice!

Configuration:

Now let’s review the steps for adding one of our new forms to an ItemType. In this example, we will use the Part ItemType, but you can use any ItemType you choose.

First start by logging into your Aras Innovator instance and go to the TOC > Administration > ItemTypes to search for the Part ItemType and open it
Next click the Edit button and select the Views relationships tab
Add another form by clicking the “New Form” button
In the “Form Name” type in something like "Responsive Form” and set the “Type” to “Default”
Give the new form a "Classification;" in our example we will use “Software”
Click on the Done button and open the new responsive form
When the form opens you will first see the old editor format; at the top there is a button for “Switch to Responsive Form”. Note when switching to a responsive form, if there was already a previously designed one the responsive switch will not carry over its data
It should look like this after the switch:
As you can see on the farthest left side of the editor there are two different sets of elements we can select blocks from, Structure and Unused Properties. Structure can be used for formatting elements into columns and boxes. Unused Properties are simply the properties we can include on the form such as part number or description.
For simplicity, let's create a very simple form and add 2 columns with 4 properties. First, click and drag “2 Column Set” into the form, then drag "keyed_name" and "Part Number" into the left column; then drag "Name" and "Description" to the right column. It It should look like this:
If you click on any of the elements dragged into the form you will see more configurations on the right pane as well. Let's click on the "Keyed_Name" property and give it another name, such as simply “Name”
Now let's take a look at the form in action and make sure it looks the way we want it to. Open up the TOC > Design > Click on Parts and then click on "Create New Part"
Initially we will see the old default Part Form, but we can change it to the new form using the classification we set earlier. Click on the Type property and select “Software” from the drop-down:
If everything is configured correctly it should look like this:

Conclusion:

Thank you for following our short tutorial on responsive forms. Let us know if this blog was useful in the comments below! In future posts we can delve into more detail and review customizations in the responsive editor.

Error: Cannot access OAuth Server due to 502 (Bad Gateway)

jonfurniss — Fri, 17 Jul 2020 22:30:20 GMT

I'm attempting to install Aras 12 on a Windows 10 machine, following this guide: https://community.aras.com/b/english/posts/configuring-your-development-machine-for-aras-innovator

After a bunch of attempts, I'm pretty sure I have all of the right things installed:

.NET Framework 4.7.2
ASP.NET Core/.NET Core 2.1.8
Microsoft Visual C++ 2015 Redistributable
IIS is turned on and all the correct features are activated
SQL Server 2014

Aras installs without any issues, but when I try to connect to localhost/InnovatorServer, I get "Error: Cannot access OAuth Server due to 502 (Bad Gateway)"

Going to Windows Event Viewer for more details, I get:

Application 'MACHINE/WEBROOT/APPHOST/DEFAULT WEB SITE/INNOVATORSERVER/OAUTHSERVER' with physical root 'C:\Program Files (x86)\Aras\Innovator\OAuthServer\' failed to start process with commandline 'dotnet .\Bin\Aras.OAuth.Server.dll', ErrorCode = '0x80004005 : 80008083.

Googling tells me that those error codes mean:

0x80004005 – file is missing or cannot be accessed,
0x80008083 – code for version conflict.

I have confirmed that the dll is in the OAuthServer\Bin file.

I have tried uninstalling and reinstalling everything, restarting the computer between each step. I tried doing a system restore and then reinstalling everything. No matter what, I keep getting this same error, and am not really sure how to proceed.

Any advice would be greatly appreciated.

Configuring Remote Connections for your Aras Innovator Instance

Nithin Mahesh — Wed, 01 Nov 2023 11:54:00 GMT

This blog will be a quick overview of how you can make your Aras Innovator instance accessible from another machine or configure specific access URLs to your instance. Since Aras Innovator^® now utilizes Oauth 2.0, you might've seen an Invalid Redirect URI error when trying to log into your instance. Here we'll quickly show you how to get around that error, which enables you to connect to your instance in multiple ways. The configuration change is minor, and we'll walk through it together below.

Introduction

Let's go through the steps and get an external URL set up with an instance of Aras Innovator. Before proceeding, it is always recommended to take a backup of your CodeTree and DB; for this example, we will only be modifying one file, so a backup of the CodeTree will suffice. Once you have your backups continue with the rest of the steps:

First, we will need to make some changes to our OAuth server OAuth.config file. Go ahead to the following directory in your instance, which should be located in C:\{CodeTree dir}\OAuthServer\OAuth.config. Now open this up in your text editor or IDE of choice.
Scroll down until you find the tags for <redirecturis></redirecturis>. Here you will see all the valid connection URLs to access the instance. You will see there are URL defaults for different access points on your machine, such as localhost and IPv4 Addresses. Basically, we will want to add our own URL here as well. Let's say we have changed the name of our PC for the sake of our example, and we want to add a connection to the new name (VM1).
Copy the first 3 default <redirectUri></redirectUri> tags:
Paste them right below, and we will need to manually change the server names from the URL to the updated machine name, so in this case, we will be replacing "http://localhost/R28" with "http://VM1/R28":
Next, we will update the <postLogoutRedirectUris></postLogoutRedirectUris> tags similarly. Simply by copying the first redirectUri tag and pasting it below the original, changing the server name within the URL from localhost to VM1:
Now all we need to do is open up IIS and click on reset:

Voila! Go ahead and try to log into the instance with your new URL, and you will see Aras Innovator load up. Note that this can similarly be used with other URLs as well; say, if you have an instance configured on a Virtual Machine with a proxy in between, you can use the proxy URL's address to redirect to the same instance by changing the server names in the URLs as we did above.

Conclusion

Thanks for following along with our OAuth server authentication configuration steps. We hope that it was helpful and provided some more insight into setting Aras Innovator up to be more accessible to your users not only locally but from wherever they are located! Keep an eye out for a future blog showing how you can utilize this configuration to connect to your Aras Innovator instance via an external application.

Error 1720 during install

Former Member — Mon, 16 Dec 2019 22:54:31 GMT

I need help! I cannot get Innovator to install in my server. I've run out of options. Any idea on what could be causing this issue?

Event Handling Framework Overview and Installation

Nithin Mahesh — Thu, 27 Jul 2023 12:25:00 GMT

The Event Handling Framework (EHF) is Aras Innovator®’s latest platform component addition to our suite of tools. EHF brings new functionality and features enabling administrators to configure subscriptions describing events and how those events should be handled.

Leveraging a publishing queue stored in server cache, the platform component uses these subscriptions to publish event data to external systems and services asynchronously. This is one of many other features we ship with our application including the handling of onAfter and custom method code implemented events.

Overview

Now let's delve a little further and take a look at some of this functionality within Aras Innovator. The features we will be taking a look at are Subscriptions, Event Types, Event Methods, and Event Handlers.

Subscriptions

The first feature we will look at is subscriptions. The Subscription ItemType defines which Event Handlers will process all events produced by appropriate Event Types. Here are some examples of subscriptions tied to Event Types.

Here is an example of a single Subscription with an Event Type and Event Handler:

Here is another example of a Subscription with multiple Event Types and Event Handlers. In our diagram below, Subscription 2 contains 2 Event Types and Event Handlers. Each event from Event Type 2 and/or 3 will be processed by both Event Handlers 2 and 3. The same Event Type and Event Handler can also be a part of multiple Subscriptions as well!

Event Types

Building on that we can look at Event Types, which are relationships to Subscription ItemTypes. Event Types allows one to subscribe to specific system events or Item Server Events:

OnAfterAdd: The event occurs after an Item is added to the database
OnAfterUpdate: The event occurs after an Item is updated in the database
OnAfterDelete: The event occurs after an Item is deleted
OnAfterCopy: The event occurs after an Item is copied
OnAfterPromote: The event occurs after an Item is promoted to the next state
OnAfterVersion: The event occurs after an Item is versioned

Every time the appropriate system event occurs, an EHF Item Event is generated and added to the publishing events queue.

These events are generally tied to ItemTypes such as Part but can also be configured to use the method code to add events to the publishing queue as well. This Custom Event Type enables publishing for events that fall outside the scope of the EHF’s standard Item Event Types.

Custom Event methods

This is created by the administrator if they choose to use a Custom Event Type or Custom Event Handler, which requires the method execution called ehf_EventPublishers. There are two types of methods:

The method execution that adds publishing data to the queue (tied to the ItemType via server events), which also requires a reference to the Event Type via Event Type name, context item id or subject, and context item data. Here is some sample code demonstrating how to use ehf_PublishEvent action to add a custom event to the queue:

gist.github.com/.../84b0fa7dfc963b24854cc4767809c83a

The method that grabs the event data from the queue for publishing (tied to an Event Handler), which may be for post processing before publishing to Aras Innovator or elsewhere. An example of this could be to publish to another external system, say maybe Jira. Here is some example code on how to retrieve the event data from the queue for publishing:

gist.github.com/.../d8516dc2eaad08029d8c664d8450b66b

Event Handlers

Event Handlers allow the Administrator to configure how events will be processed. The Ad Hoc Event Handler enables the Administrator to specify an arbitrary C# method with custom logic that will be executed each time new events are processed.

Similarly to how we configure the Event Types as a relationship to Subscriptions, Event Handlers are another item related to Subscriptions.

Installation

Now that we have taken a look at the different ItemTypes and features, we can get into setup within our Aras Innovator instances! Before proceeding note that EHF is currently only available to Aras subscribers to download via FTP.

Let’s begin by downloading the latest Aras Update release if you do not already have it installed. Once the installation completes, we will open the application and do the following:

Go to the FTP site and download the EHF CD Image
Within Aras Update select local and then click “Add package reference”

Select the directory of the downloaded EHF Image
Then click the install button
Click through the following prompts for logging until you get to the section asking for the directory of your Aras Innovator instance
Here you will need to fill out the database information and path to Aras Innovator CodeTree
Note that you will need to point it to the Innovator folder in your CodeTree, e.g. the default path for CodeTree installation would be something like: C:\Program Files (x86)\Aras\Innovator
Hit Next at the bottom and then select your language
Press install and within a few minutes you should receive a successful result message

You can then log into your instance of Aras Innovator and utilize the new functionality. In order to verify the application is installed, all you need to do is open up the TOC > Administration > Variables and search for Event Handling Framework in the name column:

Conclusion:

As you can see configuring the EHF within Aras Innovator is not only pretty simple and easy to manage, but also customizable. Creating a new subscription with Event Types and Handlers takes only a few minutes to get up and running. Plus administrators have the option to customize events occurring after through method code!

Aras 12: Error: Cannot access OAuth Server due to 500 (Internal Server Error)

SunilReddy — Fri, 14 Jun 2019 06:51:47 GMT

Hi,

We are getting an error as "Error: Cannot access OAuth Server due to 500 (Internal Server Error)" while accessing Aras12. Please help me how to resolve this error.I'm attaching screenshot for your reference.

Thanks

Sunil

Authenticating in OAuth 2.0 with Aras RESTful API

Nithin Mahesh — Tue, 28 Feb 2023 15:30:00 GMT

Note: we will be using Postman in this post, but any API platform will work to send the same requests.

Authenticating

Before we get to the fun stuff we will need to authenticate our requests. Go ahead and open up Postman then create a new Collection workspace.

Give the new workspace a name, such as 14+ AuthServer Requests
Click on the Authentication tab on the workspace
In the dropdown select OAuth 2.0
Click Edit token configuration then scroll down to the bottom of this page to Configure New token
Set the Configuration Options to the following:
Specifically ensure the following fields are input correctly. Use the following values for the Callback URL, Auth URL, Access Token URL, and Scope
1. Callback URL: http://<servername>/<web alias>/Client/OAuth/PopupCallback
2. Auth URL: http://<servername>/<web alias>/oauthserver/connect/authorize
3. Access Token URL: http://<servername>/<web alias>/oauthserver/connect/token
4. Scope: openid Innovator offline_access
Once you have filled all of those values in, click the Get New Access Token button at the bottom left and log into the popup Aras Innovator window with your credentials
If you log in correctly you will get another popup window with the access token. Within this window click Use Token.
Now be sure to hit the Save button on the top right corner before proceeding to any next steps

Now you have officially completed authentication we can move on to the fun part, adding a query request!

Setting up GET requests for Part data

Now lets take a look at a simple query to grab all the Part data from Aras Innovator:

Right click on the Meatballs Menu on the left hand side on your 14+ AuthServer Requests workspace and select Add Request
Give the request a name, something like Part Request
Click over to the Authorization tab and in the Type drop-down select Inherit auth from parent
Make sure the request is a GET then in the Enter request URL field input the following URL: http://<servername>/<web alias>/Server/Odata/Part
Go ahead and hit Send to run the request
You should start seeing the return JSON with all the parts within your database:

If you are seeing the following screen you have successfully gotten data back from the server!

Conclusion

Authenticating in OAuth 2.0 with Aras RESTful API

Nithin Mahesh — Tue, 28 Feb 2023 15:30:00 GMT

Note: we will be using Postman in this post, but any API platform will work to send the same requests.

Authenticating

Before we get to the fun stuff we will need to authenticate our requests. Go ahead and open up Postman then create a new Collection workspace.

Give the new workspace a name, such as 14+ AuthServer Requests
Click on the Authentication tab on the workspace
In the dropdown select OAuth 2.0
Click Edit token configuration then scroll down to the bottom of this page to Configure New token
Set the Configuration Options to the following:
Specifically ensure the following fields are input correctly. Use the following values for the Callback URL, Auth URL, Access Token URL, and Scope
1. Callback URL: http://<servername>/<web alias>/Client/OAuth/PopupCallback
2. Auth URL: http://<servername>/<web alias>/oauthserver/connect/authorize
3. Access Token URL: http://<servername>/<web alias>/oauthserver/connect/token
4. Scope: openid Innovator offline_access
Once you have filled all of those values in, click the Get New Access Token button at the bottom left and log into the popup Aras Innovator window with your credentials
If you log in correctly you will get another popup window with the access token. Within this window click Use Token.
Now be sure to hit the Save button on the top right corner before proceeding to any next steps

Now you have officially completed authentication we can move on to the fun part, adding a query request!

Setting up GET requests for Part data

Now lets take a look at a simple query to grab all the Part data from Aras Innovator:

Right click on the Meatballs Menu on the left hand side on your 14+ AuthServer Requests workspace and select Add Request
Give the request a name, something like Part Request
Click over to the Authorization tab and in the Type drop-down select Inherit auth from parent
Make sure the request is a GET then in the Enter request URL field input the following URL: http://<servername>/<web alias>/Server/Odata/Part
Go ahead and hit Send to run the request
You should start seeing the return JSON with all the parts within your database:

If you are seeing the following screen you have successfully gotten data back from the server!

Conclusion

Authenticating in OAuth 2.0 with Aras RESTful API

Nithin Mahesh — Tue, 28 Feb 2023 14:32:00 GMT

Note: we will be using Postman in this post, but any API platform will work to send the same requests.

Authenticating

Before we get to the fun stuff we will need to authenticate our requests. Go ahead and open up Postman then create a new Collection workspace.

Give the new workspace a name, such as 14+ AuthServer Requests
Click on the Authentication tab on the workspace
In the dropdown select OAuth 2.0
Click Edit token configuration then scroll down to the bottom of this page to Configure New token
Set the Configuration Options to the following:
Specifically ensure the following fields are input correctly. Use the following values for the Callback URL, Auth URL, Access Token URL, and Scope
1. Callback URL: http://<servername>/<web alias>/Client/OAuth/PopupCallback
2. Auth URL: http://<servername>/<web alias>/oauthserver/connect/authorize
3. Access Token URL: http://<servername>/<web alias>/oauthserver/connect/token
4. Scope: openid Innovator offline_access
Once you have filled all of those values in, click the Get New Access Token button at the bottom left and log into the popup Aras Innovator window with your credentials
If you log in correctly you will get another popup window with the access token. Within this window click Use Token.
Now be sure to hit the Save button on the top right corner before proceeding to any next steps

Now you have officially completed authentication we can move on to the fun part, adding a query request!

Setting up GET requests for Part data

Now lets take a look at a simple query to grab all the Part data from Aras Innovator:

Right click on the Meatballs Menu on the left hand side on your 14+ AuthServer Requests workspace and select Add Request
Give the request a name, something like Part Request
Click over to the Authorization tab and in the Type drop-down select Inherit auth from parent
Make sure the request is a GET then in the Enter request URL field input the following URL: http://<servername>/<web alias>/Server/Odata/Part
Go ahead and hit Send to run the request
You should start seeing the return JSON with all the parts within your database:

If you are seeing the following screen you have successfully gotten data back from the server!

Conclusion

Creating Custom Conversion Server DLL's

Nithin Mahesh — Thu, 24 Mar 2022 14:00:00 GMT

Writing your own DLL method code gives you greater control over your Aras Innovator instance. This includes providing your users the benefit of being able to run an action without locking up the UI for methods that may take longer to process. Meaning users can stay productive and avoid waiting on tasks such as downloading multiple files.

In our last Conversion Server blog post we went over setting up the Conversion Server and creating a Conversion Server Task programmatically. Now let’s delve a bit deeper to take a look at how conversion server DLL method code is written. More specifically we will be taking a look at the interfaces we can implement to configure our custom tasks. Our example will be focused on the VaultFile Converter interface and configuration of the methods associated.

Configuring the DLL

In order to set up our custom DLL we will first need to get all of our Conversion Server configurations prepared. We will be building upon the code from our last blog post so if you are unfamiliar with these steps give that a quick read. Please note that you will also need to have a subscription to Visual Studio in order to continue on with our example.

Conversion Rule Setup

Begin by creating a Conversion Type and calling it Part BOM
Next create the Conversion Rule and call it Part BOM Rule setting the Converter Type as Part BOM. Let’s also set up the Cutoff value as 1 so that if we are testing and there are failures the Conversion Server does not run excessively in the background.
Should look like this:

ConversionServerConfig Setup

Now we will need to set up the ConversionServerConfig.xml file located in the root of the Aras Innovator installation directory
Add the Converter name as Part BOM (matching the Converter Type), the type=”PartBOMDLL.PartBOMDLL, PartBOMDLL.” The type is configured with the text before the comma as the name of the C# project namespace and after the period is the class name. Everything after the comma refers to the name of the DLL within the ConversionServer\bin folder into which we copy the DLL.

Adding Converter Type to Conversion Server configurations

Open the TOC > File Handling > Conversion Servers
Open default and add relationship Conversion Types with Part BOM selected.

Configuration of our DLL Class

We can finally get to the fun part, creating our DLL!
Open up MS Visual Studio (we are using 2019 in our example) and select Create New Project from the menu.
Search for .NET Framework and select the Class Library (.NET Framework) for C# class library(.dll).
Give it the Class Library name of PartBOMDLL, then click create.

Now on the right side of your newly created project there will be a Solution Explorer. Right click on Class1.cs and rename this to PartBOMDLL.cs and say yes to renaming the project all the references for Class1.
This is what it will look like:

Next, right click on the References and select Add Reference. Click on the Browse section on the left-hand side of the menu.
Now we will want to reference both the IOM and Conversion.Base dll’s from our ConversionServer\bin folder.
Open up your machines file directory and go to the directory of your installed Aras Innovator then open ConversionServer\bin. Copy both the IOM and Conversion.Base dll’s from here.
Now go to the location of your project and paste the selected files to the bin\Debug
Going back to our open project in VS Studio, click on Browse at the bottom right corner. Now add both dll’s from the bin\Debug folder.

Adding Our Code!

We are all set to add in our method code and get our DLL built now! Let's begin with the DLL logic.

Add in the following snippet and take a look at the commented-out lines to get an understanding of our logic:

gist.github.com/.../e675256654eee773825a3f9a8d008189

Note that as part of the ConversionFramework library we are implementing the VaultFileConverter. This is used in cases where all files that are required for conversion are located within the Aras Innovator vault. This is generally used for files we want to convert to other formats, but also for any case in which we want to add the outputted file to the vault. We can also use IConverter which is used in cases where the code should download the necessary files rather than automatically download from the vault.

In order to set up the client side configurations, code, and method code for the creation of the conversion server task copy over the code from our last blog.

Specifically add the changes for the button on the Part form, the getPartBOM method, and the createPartBOMConversionTask method.

Testing our DLL:

Now we can wrap up and add our custom DLL to Aras Innovator to test:

Go back and open up VS Studio to our DLL project.
At the top we will see Build, click on this and select build solution.
This will create the DLL code and add it to the bin\Debug directory of our project.
Copy the DLL and go back to the directory of your installed Aras Innovator instance and paste this into the ConversionServer\bin folder.
Note that whenever rebuilding the DLL from VS studio, we will also need to do the following after:
1. Open task manager and end the ConversionService.exe task
2. Restart IIS
3. Paste the updated DLL to the ConversionServer\bin directory

Let's test out our code!

Open up any Part and click the new Part BOM Report button.
Once that completes open up the TOC > File Handling > Files
Search by FileType:
In the results for the File search grid we will see the partBOM.txt file and its location meaning that it was successfully add to the Vault

Note that we can also check errors with DLL code or failures by going to the TOC > File Handling > Conversion Tasks:

Search by the custom Conversion Rule and open the last run one
Go to the Event Handlers relationship and right click

Another way to debug is through setting up debuggers in our DLL code before building it, if operating parameter DebugServerMethod is setup in the InnovatorServerConfig:

gist.github.com/.../b9848fc703d8bdc28b7ab85cb6a4867c

Conclusion

Thanks for following along with our series on custom Conversion Server development and utilizing the ConversionServerFramework library. If you are enjoying the series leave a comment below on what you would like to see next!

Creating Custom Conversion Server Configurations

Nithin Mahesh — Tue, 07 Dec 2021 15:00:00 GMT

The Conversion Server, despite its name, is a great tool that can be leveraged for time consuming processes and not just file conversion tasks. This means that it can be used for really any asynchronous process.

This is best used for tasks that may take a bit longer than the standard method, allowing users to continue with other operations within Aras Innovator. We will be taking a look at an example in this blog post with a custom configuration and go over the steps to set this up on your own machines!

Configuration

In our example we will be creating a simple method to get a list of parts in a Part BOM assembly then send them in an email. Let’s begin with setting up our Conversion Rule, Conversion Type, and Conversion Task methods.

First we will create a Conversion Type that will be required for the Conversion Rule:

Log into Aras Innovator as an Administrator and go to the TOC > Administration > File Handling and open up Conversion Types.
Go ahead and click the add item button and create a new Conversion Type calling it something like “Part BOM Email”

Now we can create our Conversion Rule:

Go back to the TOC > Administration then click File Handling and Conversion Rules
Click the create new item button again then give the rule a name such as “Part BOM Rule”
Set the Conversion Type to be “Part BOM Email”
Click done to save the Conversion Rule

Once we have completed our configuration for the Conversion Rule we will setup a method to create the Conversion Tasks using the Conversion Rule ID and Conversion Manager Identity ID.

Open up the TOC > Administration > Methods and create a new method
Give your method a name such as “createPartBOMConversionTask”
Note make sure that your method is set to server-side C#
Copy the following code to your new method:
gist.github.com/.../28849ea1031380a5c2596dee3e2f1598

Now we will need to grab the Conversion Rule ID and the Conversion Manager Identity:

Go back to the TOC > Administration > File Handling > Conversion Rule and right click on the Part BOM Rule > click Share > Copy ID
In the createPartBOMConversionTask method go ahead and add the Conversion Rule ID to the variable called “ruleID”
Open the TOC > Administration > Identities then search for the Conversion Manager
Follow the same steps to copy the ID from here and paste this into the variable called “conversionIdentityID”

In order to get the Part BOM names we will need to add another method triggered by a button we will configure on the Part form.

Create another new method and call this "getPartBOM"; set this to Client-side Javascript
Add the following code:
gist.github.com/.../52883efe0b56998d9d2f5587b1393cdb
Open the TOC > Administration > Forms and search for Part; then open it
Hit Edit and in the editor add a button
In the Field Label tab give the button a name “Part BOM Report”
Go to the Field Event tab and select the add method button, then search for and add our "getPartBOM" method
Select onClick for the event and hit the Done button to save the form

Last we will have to configure the ConversionServerConfig.xml in the root directory of your Aras Innovator instance (same place the InnovatorServerConfig.xml is found):

Open this file up and we will need to add a Converter tag to the Converters section
This will be in between the <ConversionServer> <Converters> tags as shown below:

Note we will be intentionally leaving out the DLL code for the purposes of just going over setup. If you would like to add your own custom DLL’s check out the “Example for Developing Conversion Server Tasks.pdf” in the CD image, specifically section “3 Creating the Example Converter DLL” to correctly create the Converter Class and “3.2 Build and Deploy the DLL” to create the DLL files.

In order to confirm that your configuration works correctly, do the following:

Go to the TOC > Administration > File Handling > Conversion Tasks
Search by Rule for "Part BOM Rule" and you should see the created Conversion Task
Note that it may say failed unless you have connected DLL code, but we should see the inputted Part BOM user data from our getPartBOM client method

Conclusion

Thank you for following along with this week’s blog, we hope this has given some new insight on how the Conversion Server works and other capabilities that may not have been previously know. Let us know if you have any questions about your setup or if your organization utilizes the Conversion Server for their own tasks!

Configuration file missing when adding SP9 as a reference package in Aras Update

Duncanwilliamgibbons — Tue, 11 Aug 2020 07:05:53 GMT

I get an error when adding the new SP as a reference file to Aras Update to upgrade Innovator.

"Configuration file missing in path G:\ ... package.config"

Must I extract the Zip within the Aras install folder (x86)?

CUI background Page Customization

Nithin Mahesh — Fri, 08 Oct 2021 18:30:00 GMT

As we have mentioned many times in past blog posts, the beauty of Aras Innovator is the ability to customize any aspect of the UI. We can accomplish this through the CUI (configurable user interface), which we will cover in this blog.

In recent releases of Aras Innovator 12 service packs an addition of TOC (table of contents) icons was added to the background page. This allows users, upon login, to open the search grid to an ItemType without going through the TOC. In this blog post we will take a deeper look at customization of this page.

Overview

We will begin by logging in as Mike Miller, we can see that upon login we are greeted with a page containing every single ItemType in the TOC. Let’s say, however, that Mike is a manager in your organization. He does not need to see every single icon upon login making it harder to find the ItemTypes he frequents the most.

Using the CUI we can customize this page and set criteria dependent on the users. For our example let’s configure the background page to only show Mike Miller ECNs, ECRs, ECOs, EDRs, and PRs:

1. Go ahead and logout Mike Miller and log back in as Admin

2. Open up the TOC > Administration > Configuration > Client Presentation

3. Run a search and then open up the Global client presentation

4. Click Global and open the presentation configuration

5. Here we will see two relationship items Data Model and Method, open the Data Model one (we can confirm this is the CUI element we need to edit since its location is BackgroundPage)

6. Click the edit button and then the select items button in the relationship grid below to add a commandBarItem

7. Search by name *EDR* and select the action Add and Mike Miller for the “For Identity”

8. Repeat step 7 to add ECR, ECO, ECN, and PR

9. Once you have added all of them, hit the Done button and logout

10. Sign back into Aras Innovator using the Mike Miller and we should see only the items we selected. It should look like this:

Note that other elements can be added to the background page as well such as dropdowns, check boxes, menus, and more.

Conclusion

Thank you for following along with our blog post. As we can see from our example, administrators can configure different views according to what items each team and team members use, providing easy access! Please let us know in the comments below how your organization is making use of the CUI and customizations within Aras Innovator.

Nithin Mahesh さんの グループ アクティビティ

Authenticating in OAuth 2.0 with Aras RESTful API

Authenticating

Setting up GET requests for Part data

Conclusion

File checkout (using fetchFileProperty & checkout) not working in custom user with custom identity. how to checkout file in for user not having administrator permissions ?

New Responsive Forms Features: An Overview

Configuration:

Conclusion:

Error: Cannot access OAuth Server due to 502 (Bad Gateway)

Configuring Remote Connections for your Aras Innovator Instance

Error 1720 during install

Event Handling Framework Overview and Installation

Aras 12: Error: Cannot access OAuth Server due to 500 (Internal Server Error)

Authenticating in OAuth 2.0 with Aras RESTful API

Authenticating

Setting up GET requests for Part data

Conclusion

Authenticating in OAuth 2.0 with Aras RESTful API

Authenticating

Setting up GET requests for Part data

Conclusion

Authenticating in OAuth 2.0 with Aras RESTful API

Authenticating

Setting up GET requests for Part data

Conclusion

Creating Custom Conversion Server DLL's

Configuring the DLL

Adding Our Code!

Conclusion

Creating Custom Conversion Server Configurations

Configuration

Conclusion

Configuration file missing when adding SP9 as a reference package in Aras Update

CUI background Page Customization

Overview

Conclusion

Nithin Mahesh さんのグループアクティビティ