📍 TODO: Write a project description here. What does it do and why would someone use it?
These tags denote a version or milestone for this project.
| Release | Notes |
|---|---|
| {RELEASE_TAG} | Enter your release notes here. What's new and what changed? |
These Aras Innovator releases have been confirmed or can reasonably be expected to work with this project.
| Project Release | Aras Release |
|---|---|
| {RELEASE_TAG} | List the Aras versions supported by your project here. Ex: "12 SP18" or "R14-R26" or "R31+" |
Always back up your code tree and database before applying an import package or code tree patch!
📍 TODO: Include instructions describing how to install and configure this project. See the collapsed sections below for example install instructions for Aras Update packages and manual packages.
Example for Aras Update installations
- Aras Innovator (version ___ preferred)
- Aras Update tool (version ___)
- {PROJECT_NAME} Aras Update package
- Open Aras Update.
- Select Local from the sidebar.
- Add a new package reference.
- Select the folder containing your local copy of the {PROJECT_NAME} repo.
- This folder should contain a file called
package.config.
- This folder should contain a file called
- The {PROJECT_NAME} package will now appear in your list of local packages.
- You may need to expand the window to see all of the available projects.
- Select {PROJECT_NAME} from the package list and click Install.
- Check all of the modules that you want to install and click Next.
- Choose Detailed Logging and click Next.
- Fill in the details about your Aras Innovator instance and click Install.
- After the installation completes, close the Aras Update utility and proceed to the Configuration section below.
Example for Manual installations
- Aras Innovator (version ___ preferred)
- Aras Package Import utility
- {PROJECT_NAME} Import package
- Backup your code tree and store the backup in a safe place.
- Copy the
Innovatorfolder from\CodeTreein your local repository. - Paste this folder to the root install directory of your code tree.
- This should be the same folder that contains the
InnovatorServerConfig.xmlfile.
- This should be the same folder that contains the
- Back up your database and store the BAK file in a safe place.
- Open up the Aras Package Import utility.
- Enter your login credentials and click Login.
- Note: You must log in as root for the package import to succeed!
- Enter the package name in the TargetRelease field.
- Optional: Enter a description in the Description field.
- Enter the path to your local
..\{REPO_NAME}\Import\imports.mffile in the Manifest File field. - Select the following in the Available for Import field.
- {PACKAGE_NAME}
- Select Type = Merge and Mode = Thorough Mode.
- Click Import in the top left corner.
- Close the Aras Package Import utility.
📍 TODO: Write any necessary or optional post-install configuration steps here
📍 TODO: Write step-by-step instructions for users to follow. If this project is complex, consider providing a link to a user guide document/page.
📍 TODO: If this is a technical project (like an API), include instructions for consuming it via code and/or client
Like this project and want to help maintain or improve it? Here's how you can contribute!
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request
📍 TODO: Write credits to recognize those who created or contributed to the project. Link profiles and organizations when possible.
Example: This project was created by Eli J. Donahue from Aras Labs.
📍 TODO: Choose an open source license and include it in your repository as LICENSE.md.
Example: This project is published to Github under the MIT license. See the LICENSE file for license rights and limitations.