EEforce Client Software

EEforce Client is a desktop software that designed to be as simple as possible while addressing PCB Designers needs. Its interface inspired from various similar softwares like Mentor EDM.

Key Features

• Xpedition and PADS projects can be stored and used at the same time.
• All design parts are kept in same container, not splitted to Schematic, Layout, etc. which it makes it simple to manage and store
• Designs are edited using Check-In/Check-Out cycle
• Designers can see a preview of PCB, Schematic and BOM without opening it
• Every Project can have any number of Boards
• Every Board can have any number of Versions
• Versions can be locked, tagged and pruned

EEforce Server Software

EEforce Server Software is headless HTTP server process that accesses projects files in its vault folder and provides a REST API for Client software to access, modify and remove the data that stored in vault.

Server uses Microsoft IIS web server as a Proxy.

Key Benefits comparing similar systems

• Minimalistic Resource Usage, (~40MB of RAM on Idle, Maximum 4GB at Peak)
• Simple deployment
• Simple management
• Need no perodic maintains
• All-File-System storage
• Can be used with Windows' Shadow Backup or any other file backup systems

Using Installer

Server Installer has been developed to provide roboust step-by-step installation experience.
You can follow instructions on the software or listed down below.

Deep Dive Configuration

• Changing users and Paths After Installation

  Users and paths are stored in config\config.json file in the application path. You can see its content below:

  {
  	"Configurations": {
  		"VaultFolder": "C:\\pdmserver\\vault",
  		"TrashFolder": "C:\\pdmserver\\trash",
  		"UseNTLMAuth": false
  	}
  }

  After saving this file, you must stop and wait for 10 seconds then start it again EEForce Server instance using Internet Information Services(IIS) Manager

• Relocating Vault

  For relocating Vault, you must first stop EEForce Server instance using Internet Information Services(IIS) Manager. Then, you can move your vault folder to the desired location. After moving the folder, you must follow previous article to modify client.json file.

• Setup Vault Permissions

  If you're using a network drive for vault, you must grant IIS user (IIS_IUSRS) to write and change to Vault and Trash Folders following this guide:
  1. Right-click the Vault directory, then choose Properties
  2. Go to the Security tab
  3. Find IIS_IUSRS account(If IIS_IUSRS account is not in the list, add it by clicking Edit then clicking Add, and then typing MACHINE_NAME\IIS_IUSRS in the "Enter the object names to select" field)
  4. Highlight the user in the list, click Edit, and grant the account Modify and Write permissions

  

Using Installer

Client Installer has been developed to provide roboust step-by-step installation experience.
You can follow instructions on the software or listed down below.

Installation Steps:

1. You should have a Zip file named like Client_v1.22_2020_06_21.zip Version numbers can be different than example here.
2. Extract ZIP file to a convinient folder.
3. Extracted folder should be looking like this:
   

   

4. Run ClientInstaller. If Windows asks for permission, allow it.
5. You should be seen a welcome window like this:
   

   

6. Press Start Installation Button
7. You should see the End User License Agreement page. Please take time to read the agreement carefully, and press I Agree button to continue.Please note End User License Agreement is a legally binding document. If you're not comfortable with it, you should not agree it. You can read the agreement by opening eula.rtf file which it's in the installation directory.
8. After License Agreement window, this form (System Folders) will be presented:
   

   

   • Software Installation Folder: This folder used for storing software executables. We're recommending to leave it as is. Required space is less than 50MB.
   When you finish, press Next button.
9. The next screen is the last checkpoint before installation start. You should check the informations you entered in the previous screen is correct.
   

   

   
   If you're certain the informations you've provided, press Start Installation button.
10. At this point, installer will create required folders, install some Windows packages and deploy IIS server. Please give installer some time. When installation completed, it will automatically show final page.
    

    

11. When the installation completed, this completion page will be shown. If you see this page, which means installation is completed. You can press Finish Installation button to close installer window.
    

    

First-Run Configuration

After the installation, some of the configurations, like Server URL, should be edited. Please follow steps below for complete configuration.

First Run Steps:

1. After the installation finished, EEforce icon should be appeared in your Desktop. Click it to open software.
   

   

2. When the application opened, you will see login dialog. At first start, connection settings must be updated, for this please press Settings button.
   

   

3. On the settings window, update Server URL input using your server address. Server address information appears after its installation. If you do not know your server address, please contact with server administrator.
   

   

   
   If you installed the server on your local computer with default settings, you can write this: http://localhost:8000 to the Server URL input.
   
   After updating Server URL, press Save Configuration button.
4. When you return the login window, enter the credentials defined by administrator for you.
   

   Default Admin Password

   If you're deploying the system for the first time, please use default admin credentials.
   

   User ID: admin
   Password: Passw0rd

   
   

   

5. When you enter correct login credentials, you will see license selection window.
   

   

   
   Select an available license that you desire to use and press Use Selected License button.
6. If the selected license is available, the Main Interface of EEforce Client Software will be shown.
   

   

   
   You're now finished installations and first configuration of the EEforce Client. After this point, you must do some more configurations about the PADS/Xpedition installation locations. Please refer Configuration section for those informations.

All Configurations

Before start to use the Client Software, you should complete the configurations. For this please follow the steps below.

Configuration Steps:

1. On the EEforce software, go to the Tools menu above of the screen and click Settings
   

   

2. Settings window will be shown:
   

   

   
   In the Settings window, there's 3 sub windows, respectively: Server Settings, Xpedition PCB Settings and PADS Professional Settings. You can click the menu on the left side of the window, and its associated configuration page will be shown on the right side of the window.
3. On the Server Settings Page, you can edit those settings:
   

   

   
   
   • Server URL: The URL that used to connect to the Server. You should obtain this information from your System Administrator and should not change unless explicitly requested to.
   • Local Working Directory: Software requires a local folder to download design files and open them. This folder normally stores temporary files, and should be a local folder.
   • Application Language: The language of User Interface can be selected here.
     This option is under development. You can only use English for now. Another languages will be added with software updates.
4. On the Xpedition PCB Settings Page, you can edit those settings:
   

   

   
   
   • Xpedition PCB Support: You can Enable or Disable usage of Xpedition PCB altogether. Designs that created by Xpedition PCB could not be opened if you disable this option. Note that Xpedition support is an optional feature. Enabling this option will not give you access unless you're using required License Option.
   • SDD_HOME Path: For Using Xpedition PCB with EEforce software, you must point SDD_HOME folder in your Xpedition PCB Installation path.
   • Central Library File: While opening a PCB Design, software can override Central Library file settings that is written in PRJ file in the design. This is an optional operation. You can use Environment varilables like in the example or point a LMC file directly.
   • Databook File: While opening a PCB Design, software can override Databook file settings that is written in PRJ file in the design. This is an optional operation. You can use Environment varilables like in the example or point a DBC file directly.
   • Borders.ini File: While opening a PCB Design, software can override Borders.ini file settings that is written in PRJ file in the design. This is an optional operation. You can use Environment varilables like in the example or point a INI file directly.
   • Speccomps.ini File: While opening a PCB Design, software can override Speccomps.ini file settings that is written in PRJ file in the design. This is an optional operation. You can use Environment varilables like in the example or point a INI file directly.
   • Busconts.ini File: While opening a PCB Design, software can override Busconts.ini file settings that is written in PRJ file in the design. This is an optional operation. You can use Environment varilables like in the example or point a INI file directly.
   • Part Lister Config Name: While opening a PCB Design, software can override Part Lister Config Name settings that is written in PRJ file in the design. This is an optional operation. Before using this configuration, you must ensure BOM configuration file with same name exists in WDIR or Project folder.
5. On the PADS Professional Settings Page, you can edit those settings:
   

   

   
   
   • PADS Professional Support: You can Enable or Disable usage of PADS Professional altogether. Designs that created by PADS Professional could not be opened if you disable this option.
   • SDD_HOME Path: For Using PADS Professional with EEforce software, you must point SDD_HOME folder in your PADS Professional Installation path.
   • Central Library File: While opening a PCB Design, software can override Central Library file settings that is written in PRJ file in the design. This is an optional operation. You can use Environment varilables like in the example or point a LMC file directly.
   • Databook File: While opening a PCB Design, software can override Databook file settings that is written in PRJ file in the design. This is an optional operation. You can use Environment varilables like in the example or point a DBC file directly.
   • Borders.ini File: While opening a PCB Design, software can override Borders.ini file settings that is written in PRJ file in the design. This is an optional operation. You can use Environment varilables like in the example or point a INI file directly.
   • Speccomps.ini File: While opening a PCB Design, software can override Speccomps.ini file settings that is written in PRJ file in the design. This is an optional operation. You can use Environment varilables like in the example or point a INI file directly.
   • Busconts.ini File: While opening a PCB Design, software can override Busconts.ini file settings that is written in PRJ file in the design. This is an optional operation. You can use Environment varilables like in the example or point a INI file directly.
   • Part Lister Config Name: While opening a PCB Design, software can override Part Lister Config Name settings that is written in PRJ file in the design. This is an optional operation. Before using this configuration, you must ensure BOM configuration file with same name exists in WDIR or Project folder.

Using User Management Section

1. When logged in as admin user, follow Tools -> User Management menu

   

2. When the User Management dialogs open, you will see very simple window that allow you to manage users in the system.

   

Creating a New User

In User Management Window, Press New User button. This dialog will be opened:

• User ID: The identifier name of user. This must be a lowercase string. No spaces and non-english characters allowed for this field. Be aware that when a new user has been added, this user could not be removed from the system and changing the user id's are not allowed either.
• User Name: Please enter the actual name of the user in this field.
• Password: Please define password for this new user. Password must be at least 7 characters long and can be at most 20 characters long.
• Retype Password: Re-type the password defined the above field.
• Role: In the system, two types of roles are defined. Super User can access every project in the system. Normal User however only access projects where they're specifically authorized in the project settings. EEforce defines access as Write permission. Every user in the system has at least read-only access to all projects.

Changing Informations Of a Existing User

In User Management Window, Select the user you want to change informations, Right Click it and press Change Informations button. This dialog will be opened:

• User ID: This field could not be changed due to permission management in the system.
• Active: You can disable access of user by making Active unchecked.
• User Name: Actual name of the user.
• Role: In the system, two types of roles are defined. Super User can access every project in the system. Normal User however only access projects where they're specifically authorized in the project settings. EEforce defines access as Write permission. Every user in the system has at least read-only access to all projects.
• Change Password: If you do not want to change user's password, leave this unchecked.
• Password: You can reset password of this user. Password must be at least 7 characters long and can be at most 20 characters long.
• Retype Password: Re-type the password defined the above field.

Using Project Explorer Section

Project Explorer section contains a list for projects. You have a search option and a filter option. Your filter preferences are stored and after re-opening the software those preferences are restored back.

Filter Options:

• Active Designs: This options will show only those project which has a checked-out design inside. Check-Outs may be performed by anybody in the system.
• Recent Designs: This option will show only recently checked-out projects by you.
• All Designs: This option will show all projects in the system.

In the Project Explorer section, projects may have different icons. All icons has different meanings:

• 

  
  Read-Only Projects: Lock icon means that you do not have edit permissions on the project. You can open design content Read-Only.

• 

  
  Available Projects: This is the default look of the projects that you have rights to edit. This icon also show there's no actively working user on the project.

• 

  
  Actively Used Projects: This icon also means that you have rights to edit on the project, but there's some other user who is working some of the designs in the project.

• 

  
  Active Projects: This icon also means that you have rights to edit on the project, and you have checked-out one or more designs in this project.

Creating New Project

For creating a new project, follow the steps explained below. Please note that the creating new project will only allow you and the super users to edit project information.

1. Right-click anywhere in Project Explorer section,
2. Press New Project button in the popup menu.
3. A dialog will be opened, enter name of the new project and press OK
   

   

4. New project should be visible in Project Explorer section.

Changing Project Name

There should be no check-outs in the project and you should have editing permissions. For changing project name, follow the steps explained below.

1. Right-click project name in the Project Explorer section.
2. Press Properties button in the popup menu.
3. Properties dialog will be opened:
   

   

4. Type new name of the project into Project Name input box.
5. Press Save Properties button.

Changing Project Users

There should be no check-outs in the project and you should have editing permissions. For changing project users, follow the steps explained below.

1. Right-click project name in the Project Explorer section.
2. Press Properties button in the popup menu.
3. Properties dialog will be opened:
   

   

4. For adding new user: Select user from the drop-down box beneigh the Authorized Users list, press Add button.
5. For removing an existed user: Select user in Authorized Users List, press Remove Selected button.
6. Press Save Properties button.

Cloning Project

There should be no check-outs in the project and you should have editing permissions. Cloning a project will copy all design files as a new Project. Please follow the steps explained below.

1. Right-click project name in the Project Explorer section.
2. Press Clone Project button in the popup menu.
3. A dialog will be opened, enter the name of the new project and press OK
   

   

4. Cloned project should be visible in Project Explorer section.

Removing Project

There should be no check-outs in the project and you should have editing permissions. Removing a project will also remove all containing designs. If you're sure to remove it, follow the steps explained below.

1. Right-click project name in the Project Explorer section.
2. Press Delete Project button in the popup menu.
3. A confirmation dialog will be opened. If you're sure to remove the design, press OK
4. Design should be removed from the Project Explorer list.

Importing Board Into Project

For importing an external design into the project, please follow these steps.

1. Select target project in the Project Explorer section. If you do not have project yet, follow Creating New Project section.
2. After selecting target project, In Boards section, right click an empty area. A small menu will be shown.
   

   

3. Click Import Local Board button.
4. Locate the root folder of your design in opened folder browser dialog.
   

   

   
   Note that you should pick the folder where the project (Schematic) file stored in your design.
5. Wait couple seconds for the process completed, follow the operation status from Operation Logs section.

Renaming Board

Note: Renaming is only possible if board is in Checked-In state.

1. Right Click the board
2. In the popup menu, go to Board Info then press Rename button.
3. A dialog will be shown for typing new name, type new board name there, then press OK.

Cloning Board

Note: Cloning is only possible if board is in Checked-In state.

1. Right Click the board
2. In the popup menu, go to Board Info then press Clone button.
3. A dialog will be shown for typing a name for new board, type new board name there, then press OK.

Deleting Board

Note: Deleting is only possible if board is in Checked-In state.

1. Right Click the board
2. In the popup menu, go to Board Info then press Delete button.
3. A confirmation dialog will be shown, If you sure to delete the project, press OK.

Moving Board Into Another Project

Note: Moving is only possible if board is in Checked-In state.

1. Right Click the board
2. In the popup menu, go to Board Info then press Move/Copy to Another Project button.
3. A dialog will be shown.
   

   

4. Select the Move Board option under the Operation section
5. Select the target project in the list below
6. Type a new name for the project, leave it as is if you do not want to change its name.
7. Press OK

Copying Board Into Another Project

Note: Copying is only possible if board is in Checked-In state.

1. Right Click the board
2. In the popup menu, go to Board Info then press Move/Copy to Another Project button.
3. A dialog will be shown.
   

   

4. Select the Copy Board option under the Operation section
5. Select the target project in the list below
6. Type a new name for the project, leave it as is if you do not want to change its name.
7. Press OK

Opening Design Read-Only

While you can check-out the design for editing, most of users would only open the design with no desires of editing. For this neeed, there's an option to open the design without calling check-out procedure. With this operation, a copy of design files will be downloaded into local computer, and you would able to open it with available tools. But you will not be able to update the files. The procedure:

1. Right click board or desired version of it
2. Run desired actions in under View (Open Read-Only Mode) menu.

Opening Design Editable (Check-Out)

As explained above, you can open design as editable by calling Check Out procedure:

1. Right click board or desired version of it
2. Run desired actions in under Check Out (Start Editing Mode) menu.

Finishing Editing of Design (Check-In)

As explained above, you can upload local copy of the design as a new version by calling Check In procedure:

1. Right click the board that is already Checked-Out by you.
2. Press Check In (Finish Editing) button.
3. A dialog will be shown:
   

   

4. Lock Status: If you see design as LOCKED, that means a program still running in your computer that locks some of the design files. Check if any editor window still open, close them and press Check Again button.
5. Check-In Comment: You can write short comments about the reason of this check-in. It will be shown in the versions section.
6. Remove 3D Files Option: 3D files can consume significant disk space. If you do not have any 3D work, there's still can be leftover files. Check this option if you want to remove all 3D information stored in the design.
7. Remove Unnecessary Files: There's some files that is not needed to store in the design, like log and old CCZ files. You can check this option to remove those files.
8. After completing the steps above, press Check-In button to complete process. Give it some time to upload the design to the server and track the status that shown in the Operation Logs section.

Cancelling Editing of Design (Cancel-Checkout)

As explained above, you can undo check-out if you do not want to upload local copy to the server. Please note that this operation will remove all local files related the design.

1. Right click the board that is already Checked-Out by you.
2. Press Cancel Check-Out (Discard Editing)
3. A confirmation dialog will be shown.
   

   

4. Lock Status: If you see design as LOCKED, that means a program still running in your computer that locks some of the design files. Check if any editor window still open, close them and press Check Again button.
5. After completing the steps above, press Cancel Check-Out button to complete process.

Exporting Board For Remote Working

Exporting a design for remote working will give you a ZIP file which stores all design files, and you can work on it outside the system.

1. Select project from Project Explorer section.
2. Select the board you want to work remotely in the Boards section.
3. Right click to the board, go to Remote Working menu
4. Choose Export Package
5. A File dialog will be opened. Choose a convinient folder and a name.
6. Press Save
7. You can work with the ZIP file now.

Importing Remotely Updated Board

When you worked outside the system and want to import local files As a new version of a board you can follow this procedure.

1. Select project from Project Explorer section.
2. Select the board you want to import new version in the Boards section.
3. Right click to the board, go to Remote Working menu
4. Choose Import Package
5. A folder selection dialog will be opened. Find the design you wish to import and choose it.
6. Give some time to the process, and track its status in Operation Logs section.

License Types

• License Period: Perpetual vs Term

  A Perpetual License is a permanent license that gives licensee to use it lifetime. On the other hand, Term license is a rental kind of license that gives licensee to use it for a period of time, usually for one year.

• License Kind: Floating vs Nodelocked

  A Nodelocked license can only work on a dedicated users' machine. On the other hand, Floating license can work any machine in the network without limitation.

• License Option: for PADS Pro vs for Xpedition + PADS Pro

  You have two options, if you will use the software only with PADS Professional, you can choose PADS Pro option which is cheaper. On the other hand, if you are using Xpedition, or Xpedition and PADS Professional same time, you need Xpedition + PADS Pro option.

• License Upgrade Options

  If you choose to purchase a Perpetual license, it would give you lifetime usage, but this kind of licenses comes with only 1-year Upgrade/Support. When this period ends, you can still run latest version published in this period, but you cannot run newest version that published after your upgrade period ends. With License Upgrade package, you can purchase one more year of upgrade and support.

What is Support?

We define support as efforts of prevention and resolving problems related to EEforce software. As a EEforce user, you will always be covered this support. This means you will receive:

1. Bug Fixes
2. Performance Improvements
3. New Features

How we deliver support?

1. The first step for you is reaching to your distributor support team. We provide detailed information to our distributors to give you direct support.
2. We accept bug submission through our distributors. But in extreme cases, you can directly reach us.
3. We working on ticket basis and trying to resolve every ticket as soon as possible.
4. We release updates through releases.eeforce.com