araslabs/vm-sample-application

This sample application is designed to show developers how they can use the Configurator Services API to create custom applications.

*** OUTDATED *** Variant Management Sample Application

This project may also be called the Configurator Services Sample Application.

As of 6/27/2022 this application has been archived. A superior version of this application is released as product and should be used instead. The application can be installed via Aras Update and more information can be found on aras.com

The Variant Management Sample Application shows developers how they can use the Configurator Services API to create custom variant management applications.

The Variant Management Sample Application showcases the use of Configurator Services to application developers and users interested in variant management. The sample application allows product variability to be managed and applied to product breakdown structures and allows these configurable 150% breakdown structures to be resolved when a set of options are selected. For more information on the Configurator Services API, check out the Configurator Services Programmer's Guide.

This sample application is an Aras Community Project. It is not a standard product, and should not be deployed to production as-is. The purpose of the sample application is to demonstrate the Configurator Services API capabilities so that custom applications can be built to address specific business requirements and processes.

Sample data is provided along with the sample application. Loading the sample data is optional. The purpose of the sample data is to help follow the documentation and provide ideas on how variability definition and breakdown structures can be organized and connected to each other.

Figure 1 - Variability Definition structure is separate from Breakdown Structure. Variability is applied to the Breakdown Structure at its variability points. The yellow boxes depict Breakdown Items. The red boxes are the Variable Components that have a number of Assets with their usage conditions. The green boxes depict fixed Assets that are common across all configurations.

Figure 2 - Features and Rules on Variability Item

Figure 3 – Variable Component with its Assets (e.g. Parts) and Usage Conditions

Figure 4 – 150% Breakdown Structure is resolved by selecting options

History

Release	Notes
2.1.1	Updated to support Aras 12.0 SP9.
2.1.0	Usage Condition Table Editor has been introduced to view and manage Usage Conditions of Assets on Variable Components. The Table Editor can be accessed from the Variable Component's sidebar.
2.0.0	Variability Definition is separated from Breakdown Structure, and managed independently. This makes it possible to use the same variability definition on any structure. Note: This data model is different from the previous version.
12.0 R2.0	Updated to support Aras 12.0 SP1
12.0.0.1	Updated to support Aras 12.0 SP0.
11.0.15.1	Updated to support Aras 11.0 SP15.
11.0.14.1	Updated to support Aras 11.0 SP14.
11.0.12.1	First release.

Supported Aras Versions

Project	Aras
2.1.1	12.0 SP9
2.1.0	12.0 SP4
2.0.0	12.0 SP4
12.0 R2.0	12.0 SP1
12.0.0.1	12.0 SP0
11.0.15.1	11.0 SP15
11.0.14.1	11.0 SP14
11.0.12.1	11.0 SP12

Installation

Important!

Always back up your code tree and database before applying an import package or code tree patch!

Pre-requisites

1. Aras Innovator installed (version 12.0 SP9)
2. Aras Update installed (version 1.6+)
3. Variant Management Sample Application package

Install Steps

1. Run Aras Update.
2. Select Local in the sidebar.
3. Click Add package reference and select the VM Sample Application installation package.
4. Select the newly added package from the list and click Install.
5. Select the components you want to install and click Next.
   • Aras Innovator Code Tree Updates
   • Aras Innovator Database Updates
   • Sample Data Actions (Optional)
6. Choose Detailed Logging and click Next.
7. Enter the required parameters for the target Aras Innovator instance. Which parameters are required varies based on which components you have selected to install.
   • When selecting the install path for your Innovator instance, be sure to select the Innovator subfolder.
   • Example: If your Innovator instance is installed in C:\Program Files (x86)\Aras\120SP9, select C:\Program Files (x86)\Aras\120SP9\Innovator.
8. Click Install to begin installing the package.
9. When the package finishes installing, close Aras Update.

Load Sample Data (Optional)

1. Log into Innovator as admin.
2. In the main menu, select Actions > Load Variant Management Sample Data.
3. When prompted, enter the file path of the Variant Management Sample Application package.
   • Example: If the Variant Management Sample Application package was downloaded and unzipped to C:\VMSample, enter C:\VMSample.
4. Running the Load Variant Management Sample Data action will overwrite any variant sample data loaded by a previous execution. Click Ok in the warning prompt to continue loading.
5. After the load completes, navigate to Variant Management in the TOC to confirm that instances of Features, Options, Breakdown Items, Variability Items, and Variable Components have been added.

Usage

For information on using the sample application, view the documentation.

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request.

For more information on contributing to this project, another Aras Labs project, or any Aras Community project, shoot us an email at [email protected].

Credits

Sample application created by Aras Development.

License

Aras Labs projects are published to GitHub under the MIT license. See the LICENSE file for license rights and limitations.

vm-sample-application's Issues

Images are missing in the latest release

Hi guys,
thank you for this release.
Did you forget to add images folder to v2.1.1
Cheers,
Alexei Pavlov

button Get Reasons is not working

Expected Behavior

after click n Get reasons button I see Conflicts tab

Actual Behavior

nothing happens

Steps to Reproduce

1. select invalid option
2. click Get reasons
   

Environment Details

Aras Innovator

• Major version: 12.0
• Service pack(s): SP9

Browsers

• Internet Explorer 11
• Firefox ESR
• Chrome
• Edge

Project Version

2.1.1

Additional Details

Workaround / Solution

did not find(

Collaboration

yes

[IDEA]

Challenge / Pain Point

The generated product variant a.k.a. BOM report (last step of user guide) can not be saved / transfered to excel / copied to clipboard / printed.

Proposed Solution

Specific variant BOM should be stored in the database, at least excel export would be great.

Additional Details

I know this is just a show case example, but i am using this to demonstrate variant management in PLM to students in university.

Collaboration

I can help with use-case example, testing or such. Unfortunately I am not familiar with the API or programming apps so far.

Cannot be viewed correctly

For version 12.0, it cannot be found in the directory after successful installation

VM Update Failed

While installing VM package we are getting below issue. Early response is appreciated.

Generic Item Structure & Family Structure Tabs missing from Generic Item Relationship Types (Instance: Innovator 11SP12)

Issue with the generic item (Above image shows the item as it appears on our Innovator 11SP12 instance).
While the configurator Services Guidebook shows that along with the Generic Structure tab, ther is a Gneric Item structure tab (like so:

and there should be a Family Structure tab (like so:

However these 2 tabs do not appear when the configurator services is installed for some reason. These are the relationship types that are linked to Generic item ItemType in Innovator:

(I have added an additional Products usage relationship to link products to the generic item at the highest level).

What is the reason for those 2 tabs to not appear? They are really useful visual representation of the configuration structure, so I am really handicapped without them. Can anybody suggest a fix or update the package to make corrections? Thanks!

[Q&A] Support to aras innovator 12.0 SP18

I need to use VM application for aras innovator 12.0 SP18. Looks like VM application does not support 12.0 SP18 https://github.com/ArasLabs/vm-sample-application#supported-aras-versions

How can I use VM application for innovator 12.0 SP18? If there is any way to add VM application in 12.0 SP18, if yes please provide a steps.

Want to have Expand and collapse tree feature on Relevant Families tree

Will it be possible to add Expand and collapse tree feature on Relevant Families tree same like Table Rule Editor already have. Also default behavior of Families tree is Expanded will it be possible to change default collapsed view.

Following is the screenshot of Expand collapse tool bar on Relevant Families Tree .

question,"M" set of Table Rule Editor[Q&A]

Tell me about this question of Variant Management
"M" can be set in the table of Table Rule Editor, but the usage is not described in the document. Please tell me how to use it.
The meaning of the cell color in the table is displayed as "Mulitple". Please tell me this as well.

Help required: Creating Generic Structure Tree view for SP12 environment (similar to VM-sample-app designed for SP14)

Is it possible to add a new relationship type with the 'generic item structure' view for the sample application in Innovator 11sp12 like the one provided in the application for SP14? I assume this is quite similar to the BOM structure view using the Multilevel BOM relationship used in the part item type. Would it be possible for someone to guide/ provide sample code, on how to set this up, as this is a really useful feature to see the whole configured superbom structure, instead of having to click through and open each level of the hierarchy