IRONCAD Client Function Descriptions

IRONCAD Client Function Descriptions

IRONCAD Client Function Descriptions

Login

Login is the first step for using the Add-In. Before logging in to the cloud, all functions are disabled except Options. Login requires a login email and password. After clicking the Login button, the login dialog will pop up.

Logout

This just logs the user out of cloud.

Ribbon Bar and Toolbar

Once IRONCAD is running, the commands for IRONCAD Synergy can be found on the Add-Ins Ribbon group. Quick Commands are also available on IRONCAD Toolbar.

This is the IRONCAD Ribbon Bar for Synergy Add-In. Add, Check In, Check Out, and Undo Check Out are able to be select for us on the document currently active in IRONCAD.

The Toolbar can be found on the left side of the IRONCAD window.

Check In

If the active document is Checked Out, the user can check it in to the cloud by clicking the Check In button. It will search for all the external linked files and list them all on the Check In dialog. The user can choose to check in or add if the document is not in the cloud each file.

Add to Synergy Vault

This command adds the current active document to the cloud. If the document is not saved, it will prompt the user to save it first. The document will be saved to the working folder.

After saving the file, the process is same as the Check In process (more details above). After clicking the OK button on the Check In dialog, the Documents form will be shown to let the user to select a folder for the new document. All new external reference documents will go to the same folder. Clicking the Cancel button on any dialog will cancel the add document process.

Check Out

This command is to check out the active file from the cloud, which is only possible if the file is not checked out already. The first step is to query the external linked files from the cloud, which are listed on the Check Out dialog. The user can choose which file to checkout as well as add comments for checking out. Any comments will appear in Lock Description field. Please note the comment will be lost after the document is Checked In again, which means users may want to get files from the cloud, even the main goal is not to check out the file.

Undo Check Out

This command is to cancel the Check Out action performed before. The Undo Check Out command only acts on the active document. Any external linked files are not affected. There is no specific UI for this process and if the document is modified, the changes will still occur in the local file. To discard any changes made during this process, get the file from the cloud and overwrite them.

View Document

This command is used to get the active document and its external references from cloud to local for viewing while not checked out. Similar to Check Out, this is not recommended while the document is open in IRONCAD.

Options

This command is used to set/change options. This button is active before the user login. Clicking it will bring up the Options dialog. Currently there are three options available.

  • Login – The user’s login name (email). It is not required and it is for the user’s convenience.
  • URL – It should point to the URL of the Synergy Platform site. It is required and needs to be setup before using the client. The default URL is https://synergy.ironcad.com.
  • Working Folder – Where the local files will be saved. It is required and needs to be setup before working with files.

Working List

This command is used to manage the file list in the Working folder, and only documents in the cloud will be listed here. Any documents downloaded from the cloud (via check out or view) will be automatically added to this list. The list could grow rapidly and will need consistent management to avoid becoming cluttered.

The buttons on this dialog perform management task and are defined below:

  • Refresh – Refresh the dialog.
  • Sync Local – Synchronize the list with local working folder. Documents deleted from the working folder will be removed.
  • Sync Cloud – Synchronize the list with the cloud. Documents not in the cloud (deleted by someone) will be removed.
  • Remove – Manually remove selected documents from the list.
  • Close – Close the dialog.