Объект ‘objects’

almaGRID API

Методы #

AddByTagLabels #

Поддержка в версии: старше или равно 34.24.2.0.

Overview
Добавляет в базу данных объект. Если объект с таким набором тегов уже присутствует в базе данных, то перезаписывает его, если нет, то создает новый. Если значение добавляемого объекта является пустой строкой, то такой объект удаляется из базы данных.

AddByTagLabels  ( ObjValue  String , ObjValueType  String , TagLabel1  String , [TagLabel2  String  = null ], [TagLabel3  String  = null ], [TagLabel4  String  = null ], [TagLabel5  String  = null ], [TagLabel6  String  = null ], [TagLabel7  String  = null ] ) : String 

Возвращаемое значение
Тип: String
Возвращает ObjId добавленного или обновленного объекта. Если добавить объект не удалось, то возвращает пустую строку.

Параметры

VBScript

ag.app.AddByTagLabels 356, "Number", "Температура, С", "Значение"

almaGRID API

AddByTagPaths #

Поддержка в версии: старше или равно 34.24.2.0.

Overview
Добавляет в базу данных объект. Если объект с таким набором тегов уже присутствует в базе данных, то перезаписывает его, если нет, то создает новый. Если значение добавляемого объекта является пустой строкой, то такой объект удаляется из базы данных.

AddByTagPaths  ( ObjValue  String , ObjValueType  String , TagPathOrId1  String , [TagPathOrId2  String  = null ], [TagPathOrId3  String  = null ], [TagPathOrId4  String  = null ], [TagPathOrId5  String  = null ], [TagPathOrId6  String  = null ], [TagPathOrId7  String  = null ] ) : String 

Возвращаемое значение
Тип: String
Возвращает ObjId добавленного или обновленного объекта. Если добавить объект не удалось, то возвращает пустую строку.

Параметры

VBScript

ag.app.AddByTagPaths "Flow1", "Text", "sa123s", "sa456s"
ag.app.AddByTagPaths "Flow1", "Text", "sa123sANDsa456s"

almaGRID API

AddCsv #

Overview
Устаревшее. Для чтения данных из csv-файлов рекомендуется использовать app.NewReader.

Добавляет в базу данных объекты из файла csv. Если объекты с таким набором тегов уже есть, то перезаписывает их, если нет, то создает новые. Если значение добавляемого объекта является пустой строкой, то такой объект удаляется из базы данных.

AddCsv  ( FilePath  String , Mode  String  )

Параметры

VBScript

if AG.Err.ErrorCode = 0 then
    ag.app.CsvDelimiter  ";"
	ag.app.ScriptEncoding "UTF8"
  	ag.app.DateFormat("dd.MM.yyyy")
	ag.objects.AddCsv ScriptDir & "\Test-2.csv", "Table_TagLabels_Type"
end if

Файл «Test-2.csv»:

;[=>] [Тег1] AND [Теги для документов] ;[=>] [Тег2] ;[=>] [Тег3] 
;Date;Text;Logical
[Тег21] AND [Теги для замены] ;02.02.2022;Текст 1;false
[Тег22] ;03.02.2022;Текст 2;true
[Тег23] ;04.02.2022;Текст 3;false

almaGRID API

AddObject #

Overview
Добавляет в базу данных новый объект. Если объект с таким набором тегов уже присутствует в базе данных, то перезаписывает его, если нет, то создает новый. Если значение добавляемого объекта является пустой строкой, то такой объект удаляется из базы данных.

AddObject  ( ObjId  String , ObjValue  String , ObjValueType  String , ObjTagsXML  StringXML  ) : String 

Возвращаемое значение
Тип: String
Возвращает ObjId добавленного или обновленного объекта. Если добавить объект не удалось, то возвращает пустую строку.

Параметры

VBScript

if ag.err.ErrorCode = 0 then
  ag.app.ScriptEncoding "Default"
  ag.objects.AddObject("", "0.32", "Number", "<prm><tag label='[Отсутствует регулярная оценка рисков]'/><tag label='[=>][Выполнение проекта превысит ожидаемые сроки]'/></prm>")
end if

almaGRID API

Aggregate #

Overview
Создает коллекцию объектов базы данных в соответствии с правилами, определенными в ObjTagSet.

Aggregate  ( ObjTagSet  TagSet  ) : ObjCollection 

Возвращаемое значение
Тип: ObjCollection
коллекцию объектов базы данных.

Параметры

VBScript

set oc1 = ag.objects.Aggregate(TagSet1)

almaGRID API

Find #

Overview
Ищет в текущей базе данных объекты, теги которых содержат заданные теги.

Find  ( ObjTagsXML  StringXML  ) : ObjCollection 

Возвращаемое значение
Тип: ObjCollection
Коллекция объектов, теги которых содержат теги, указанные в ObjTagsXML.

Параметры

VBScript

'ищем объекты базы данных модели, содержащие тег "a1"
set ObjCollection1 = ag.objects.Find("<prm><tag label='a1'/></prm>")

almaGRID API

GetByTagLabels #

Поддержка в версии: старше или равно 34.24.2.0.

Overview
Ищет в текущей базе данных объект с заданными названиями тегов.

GetByTagLabels  ( TagLabel1  String , [TagLabel2  String  = null ], [TagLabel3  String  = null ], [TagLabel4  String  = null ], [TagLabel5  String  = null ], [TagLabel6  String  = null ], [TagLabel7  String  = null ], [TagLabel8  String  = null ], [TagLabel9  String  = null ] ) : Obj 

Возвращаемое значение
Тип: Obj
Объект базы данных. Если такой объект отсутствует в текущей базе данных или таких объектов несколько, то свойство Id возвращаемого объекта равно пустой строке.

Параметры

VBScript

'Значение тега (узла графа) "Процесс1"
Value1 = ag.objects.GetByTagLabels("Значение", "Процесс1").Value

'Значение дуги графа "Процесс1->Процесс2"
Value1 = ag.objects.GetByTagLabels("Процесс1", "[=>][Процесс2]").Value

'Значение объекта (свойства) "Процесс1"
Value1 = ag.objects.GetByTagLabels("Процесс1", "Стоимость, руб./час").Value

almaGRID API

GetByTagPaths #

Поддержка в версии: старше или равно 34.24.2.0.

Overview
Ищет в текущей базе данных объект с заданными TagPath тегов.

GetByTagPaths  ( TagPathOrId1  String , [TagPathOrId2  String  = null ], [TagPathOrId3  String  = null ], [TagPathOrId4  String  = null ], [TagPathOrId5  String  = null ], [TagPathOrId6  String  = null ], [TagPathOrId7  String  = null ], [TagPathOrId8  String  = null ], [TagPathOrId9  String  = null ] ) : Obj 

Возвращаемое значение
Тип: Obj
Объект базы данных. Если такой объект отсутствует в текущей базе данных или таких объектов несколько, то свойство Id возвращаемого объекта равно пустой строке.

Параметры

VBScript

Value1 = ag.objects.GetByTagPaths("as123sa456s", "as789sa101s").Value

almaGRID API

GetObject #

Overview
Ищет в текущей базе данных объект с тегами, заданными в ObjTagsXML.

GetObject  ( ObjTagsXML  StringXML  ) : Obj 

Возвращаемое значение
Тип: Obj
Объект базы данных. Если такой объект отсутствует в текущей базе данных или таких объектов несколько, то свойство Id возвращаемого объекта равно пустой строке.

Параметры

VBScript

if AG.Err.ErrorCode = 0 then
  set Obj = ag.objects.GetObject "<prm><tag label='[Отсутствует регулярная оценка рисков]'/><tag label='[=>][Выполнение проекта превысит ожидаемые сроки]'/></prm>"
  ag.app.MsgBox Obj.ObjID
end if

almaGRID API

RemoveObject #

Overview
Удаляет из текущей базе данных объект с заданным ObjId.

RemoveObject  ( ObjId  String  ) : Boolean 

Возвращаемое значение
Тип: Boolean
True - если объект успешно удален False в противном случае.

Параметры

VBScript

ag.objects.RemoveObject(obj1.Id)

almaGRID API

RemoveObjects #

Overview
Удаляет из текущей базе данных объекты, находящиеся в заданной коллекции ObjCollection.

RemoveObjects  ( ObjCollection  ObjCollection  ) : Boolean 

Возвращаемое значение
Тип: Boolean
True - если объекты успешно удалены False в противном случае.

Параметры

VBScript

ag.objects.RemoveObjects(ObjCollection1)

almaGRID API