EKM
This namespace holds top-level commands and queries related to Engineering Knowledge Manager.
Get changes of the project from EKM repository.
Optional Arguments
The following example illustrates the obtaining of project changes from an EKM repository.
EKM.GetChangesFromRepository(BackupProject=False,
Checkout=False)
Starts Workbench server and writes connection string in working directory. This connection string is used to set up socket connection with Workbench and control it from EKM.
Launches EKM Desktop.
Required Arguments
Open an archived project from EKM repository to Workbench. The opened project will also saved in your local disk with repository info saved in the local project. Once it's opened, user can modify and save the project locally, send local changes to repository, and also update local project from repository if the project is changed in repository.
Required Arguments
Optional Arguments
The following example illustrates the opening of an archive from an EKM Repository to local disk.
EKM.SaveToRepository(RepositoryPath=r"\\path_to_EKM_repository\archived_project.wbpz", // Required
ProjectPath=r"\\local_project_path", // Required
CheckOut=False // Optional, applicable only if the project is under version control
)
Save archived project to EKM repository. The project must be saved before calling this command. A warning will popup if not saved.
Required Arguments
Optional Arguments
The following example illustrates the saving of an archive to an EKM Repository. It will save the specified archived project to the specified EKM repository, placing it under source control, and checking it out to my local machine.
EKM.SaveToRepository(RepositoryFolderPath=r"\\path_to_EKM_repository",
IncludeResultFiles=True,
IncludeExternalFiles=True,
GetExclusiveControle=False,
PlaceUnderVersionControl=False,
CheckOut=False,
Description="My Sample EKM Project Save")
Save archived project to EKM repository. The project must be saved before calling this command. A warning will popup if not saved.
Required Arguments
Optional Arguments
The following example illustrates the sending of project changes to an EKM repository. The specified archived project will be sent to the specified EKM Repository. The additional arguments specify, in order: (1) Whether a new EKM project version will be assigned (InExiting). (2) Source control behavior (CheckinOption : a value greater than zero will issue a checkin. A value of 2 will check out the project after a successful checkin.). (3) Whether to release the exclusive control (lock) upon successful project submission (ReleaseExclusiveControl).
EKM.SendChangesToRepository(RepositoryPath=r"\\path_to_my_EKM_repository",
InExiting=True,
CheckinOption=0,
ReleaseExclusiveControl=False,
Comments="These are my comments for my changes")