Repository

Creating a Local Repository

Workspace: The workspace is a folder on your hard drive that contains internal data about connections to a repository and the projects that you have imported from this repository.

Repository: The repository is a database that contains the current files for your projects. If you connected to an existing repository, you can import its contained projects.

  1. Selecting a workspace directory.
  2. Creating a local repository.
Connecting to a Central Repository
  1. Select a directory for the workspace.
  2. Connect to an existing remote repository.
  3. Enter the IP address of the host server.
  4. Enter the port number.

Please make sure of the following points if there are no repositories displayed.

  • The host server is running and reachable.
  • Check your firewall settings.
  • Check your VPN settings.

Login

Default Login
  1. Enter the User ID: Administrator.
  2. Enter the Password: 0000.

Activating the SOX License

In order to request a license, please open the „Request License“ tab of the SOX license manager. The license manager is an entry on Help menu.

  1. Open the SOX License Manager
  2. Enter the Serial Key

SOX Projects

Creating a New Project
  1. Open the New project dialog.
  2. Enter the project properties.
Exporting a Project
  1. Open the SOX Project Export wizard.
  2. Select a directory.

Export as an Archive

 

Export to a Folder

Importing a SOX Project from the Repository
  1. Navigate to the Repository view.
  2. Open the Import SOX Repository Project dialog.
Deleting a SOX Project

Deleting the project in Workspace means that the project will no longer be visible in your workspace but it will still exist in the repository. It can also be imported again into your workspace.

After deleting the project in Repository all the project files will be erased from your workbench and the repository database for you and every other user of this repository.

  1. Navigate to the Repository view.
  2. Delete the project in workspace.
  3. Delete the project in repository.
Editing Project Code
  1. Open the Properties for Project dialog.
  2. Enter the desired Project Code.

BID formatting

BID formatting

BIDname${PC}${SN} where BIDname is the desired name. PC is for Product Code. SN means serial number.

Use ${DB} to display the DB-ID of the object. This only remains within one repository clearly.

  1. Open the Properties for Project dialog.
  2. Select a document.
  3. Edit the BID.

Catalogs

Creating Employee Catalog

In the Employee Catalog you can define team members. You can access the whole catalog of employees across your projects. In the catalog you can assign team members to projects, add contact information and, later on, you can assign those team members to tasks.

  1. Navigate to the Catalogs view.
  2. Open the Companies catalog.
  3. Open the New Company dialog.
  4. Open the New Department dialog.
  5. Open the New Employee dialog.
Editing Employee Catalog
  1. Navigate to the Catalogs view.
  2. Open the Companies catalog.
  3. Drag & drop an employee into another department or company.
  4. Edit the name, contact information and where the selected employee works.
  5. Deactivate/activate an employee.
Export-Import Catalogs

Public: Here you can find the copied catalogs. You can also create new catalogs by right-clicking inside the
public folder and choosing New. All users of the same repository can access the „Public“ folder

System: The system folder contains all the catalogs that are shipped with SOX. You cannot edit the catalogs
in the system folder!

  1. Open the Catalogs view.
  2. Open the Catalog Export wizard.
  3. Select a storage location.
  4. Open the Import wizard.
  5. Select a SOX catalog (.sxcat)

Workflows

Customizing Workflows
  1. Change a State.
  2. Open the Workflow editor.
  3. Add a new State.
  4. Add an Action.
  5. Add a Transition.
  6. Save the changes.
Export Workflows

Precondition: Workflow editor was opened.

  1. Open the Export wizard.
  2. Select a storage location.
Import Workflows

Precondition: Workflow editor was opened.

  1. Open the Import wizard.
  2. Select a SOX workflow (.sxcat).

Switching language

Starting SOX english version

The default language of SOX depends on your system language. At the moment only English and German are available. To change the language it is necessary to add the following listed parameter to the shortcut file of SOX.
German Language: -nl de
English Language: -nl en

  1. Create a SOX shortcut.
  2. Open the properties dialog.

Working with Versions

Creating and deleting a Version

SOX allows you to save Projects in different Versions. This means SOX freezes the Project to its current state and provide it with a timestamp. They are mainly intended for comparison purposes.

Each Project starts at a branch called Main. Branching means you diverge from the Main line of development and continue without messing with that main line.

  1. Open the Create a new Version dialog.
  2. Double click on the created Version to switch the Project to this Version.
  3. Open the Create a new Version dialog.
  4. Select the Switch to branch/version after creation checkbox.
  5. Open the Delete dialog.

Where to find the .log file

Where to find the .log file
  1. Open the Workspace folder
  2. Select the .metadata folder
  3. Open the .log file

Where to find the Hardware-ID

Where to find the Hardware-ID
  1. Select Help
  2. Open Licence Manager
  3. Select Copy ID to clipboard

Useful features

Adding, editing and deleting Comments

The Comments can be used for all objects in each Module of SOX.

  1. Open the desired document.
  2. Open the New comment dialog.
  3. Navigate to the Properties view.
  4. Double click the Comment to edit it.
  5. Open the Delete dialog.
Adding and deleting Hyperlinks

The Hyperlinks can be used for all objects in each Module of SOX.

  1. Open the desired document.
  2. Open the Add hyperlinks dialog.
  3. Enter a name and the URL.
  4. Navigate to the Properties view.
  5. Open the Hyperlink.
  6. Open the Delete dialog.
Back
Scroll to top