Search Administrator API

AddUser

Функция создает новую учетную запись пользователя.

Синтаксис:

Function AddUser(const LoginName: WideString; const FullName: WideString; const Password: WideString): Integer;

LoginName - имя для входа
FullName - полное имя
Password - пароль

Результат - в случае успеха - идентификатор нового пользователя, иначе 0

AddExtUser

Функция создает новую учетную запись внешнего пользователя.

Синтаксис:

Function AddExtUser(const FullName: WideString): Integer;

FullName - полное имя

GetFieldValue_User

Функция возвращает значение дополнительного параметра учетной записи пользователя.

Синтаксис:

function GetFieldValue_User(UserID: Integer; const FieldName: WideString): WideString;

UserID - идентификатор пользователя
FieldName - имя изменяемого поля
Возвращаемое значение - значение запрошенного поля

Допустимые имена полей можно посмотреть в таблице USERS_INFO

SetFieldValue_User

Процедура изменяет дополнительные параметры учетной записи пользователя.

Синтаксис:

Procedure SetFieldValue_User(UserID: Integer; const FieldName, FieldValue: WideString);

UserID - идентификатор пользователя
FieldName - имя изменяемого поля
FieldValue - значение

Имена полей находятся в таблице USERS_INFO

DeleteUser

Функция удаляет существующую учетную запись пользователя.

Синтаксис:

Function DeleteUser(UserID: Integer);

UserID - идентификатор пользователя

UserParamsDlg

Функция, вызывающая диалог свойств пользователя.

Синтаксис:

Function UserParamsDlg(UserID: Integer): Integer;

UserID - идентификатор пользователя

Результат - 0 - если диалог был отменен, 1 - если была нажата "ОК".

AddUserGroup

Функция создает новую группу.

Синтаксис:

Function AddUserGroup(const GroupName: WideString; const GroupDes: WideString; ParentGroupID: Integer): Integer;

GroupName - наименование группы
GroupDes - описание группы
ParentGroupID - ID родительской группы

AddUserFolder

Функция создает новую категорию (категория - это папка, куда можно помещать элементы схожего профиля, например организации, работающие в одной отрасли).

Синтаксис:

Function AddUserFolder(const GroupName: WideString; const GroupDes: WideString; ParentGroupID: Integer): Integer;

GroupName - наименование категории
GroupDes - описание категории
ParentGroupID - ID родительской категории

AddUserOrganization

Функция создает новую организацию.

Синтаксис:

Function AddUserOrganization(const GroupName: WideString; const GroupDes: WideString; ParentGroupID: Integer): Integer;

GroupName - наименование организации
GroupDes - описание организации
ParentGroupID - ID родительской организации

AddUserToGroup

Процедура, включающая пользователя в группу (организацию).

Синтаксис:

Procedure AddUserToGroup(UserID, GroupID: Integer);

UserID - идентификатор пользователя
GroupID - идентификатор группы (организации)

SetFieldValue_Group

Процедура изменяет дополнительные параметры учетной запись пользователя.

Синтаксис:

Procedure SetFieldValue_Group(GroupID: Integer; const FieldName: WideString; const FieldValue: WideString);

GroupID - идентификатор пользователя
FieldName - имя изменяемого поля
FieldValue - значение

Для обычной группы можно изменить наименование (NAME_GROUP) и описание (NOTES), для организации данная процедура может изменить все реквизиты организации (перечень реквизитов можно найти в таблице ORGANIZATIONS_INFO)

Пример добавления категории, организации и записи параметров

Пример на js добавления категории, организации и записи параметров.

Search Administrator должен быть запущен.

В примере 999999997 - идентификатор узла "Организации" - это константа.

SAdmin = new ActiveXObject("ADMIN.SearchAdmin");
SAdmin.Login();
main();
function main()
{
// 999999997 - идентификатор узла "Организации"
 res = SAdmin.AddUserFolder("Новая категория","описание категории",999999997);
 if (res == 0) 
   WScript.Echo("error: "+SAdmin.ErrorMessage)
 else
 {
  res = SAdmin.AddUserOrganization("Новая организация","описание организации",res);
  if (res == 0) 
    WScript.Echo("error: "+SAdmin.ErrorMessage)
  else
  {
   SAdmin.SetFieldValue_Group(res, 'CITY', 'Минск')
   SAdmin.SetFieldValue_Group(res, 'ADDRESS', 'Ул. Некрасова, д.1')
   SAdmin.SetFieldValue_Group(res, 'EMAIL', 'test@test.com')
  }
 }
 WScript.Echo("Done");
}