EKM Client API

- Main Page
- Namespaces
- Classes

EKM Client API

Copyright (c) 2016 ANSYS, Inc.

## Introduction

The EKM Client API is a collection of C# and Java libraries that can be used to develop client applications that interact with an EKM server. The programs can be developed in C#, Java, or Python. The API provides the following functionality:

- Search the Repository for data
- Create, update, and delete objects in the Repository
- Transfer files and folders to and from the Repository
- Perform version control and locking operations on objects in the Repository
- Execute script on the server
- Manage users and groups in the Repository
- Manage jobs and processes on the EKM server

## Installation

The libraries are installed along with the EKM server product. Under the EKM installation directory, the following directories are provided:

- ekm_base/ekm-client - the home directory for the library
- ekm_base/ekm-client/bin - scripts for running Jython and for building and running the included Java samples
- ekm_base/ekm-client/bin/[OS] - C# binaries for specific operating systems
- ekm_base/ekm-client/lib - the JAR files
- ekm_base/ekm-client/programs - additional programs needed to build and run the samples
- ekm_base/ekm-client/samples - sample applications
- ekm_base/ekm-client/schema - schema files needed by the library

After the installation is complete, add the ekm_base/ekm-client/bin directory to the path. After that, the samples can be built and run in place on the server where the library was installed.

### Installing on a Client

To install on a client, simply copy the ekm-client directory from the server install to a location on the client machine. The only prerequisite for the client machine is that it has the Java Development Kit (JDK) version 1.8 or later installed on it. Once the directory is copied to the client machine, do the following:

1. Open ekm-client/bin/ekm_env script in an editor
2. Change the EKM_BASE environment variable to point to the directory in which you placed the ekm-client directory
3. Change the JAVA_HOME environment variable to point to the JDK installation on the client machine
4. Save your changes

### Installing on a Client

Applications built using the EKM Client API rely on the client machine having a valid Java Runtime Environment (JRE) installed. The EKM Client API requires version 8 of the JRE or greater. The JRE can be downloaded from http://www.oracle.com/technetwork/java/javase/downloads/index.html. After you have the JRE installed, the path to the Java Virtual Machine (JVM) must be included in your PATH environment.

All Classes Namespaces Functions Variables Enumerations Properties