Class Util

constructor

• new Util(): Util

  Returns Util

ReadonlycanonicalServerName

ReadonlyCssClasses

ReadonlycurrentServer

ReadonlyhostAndNamespace

Readonlynamespace

ReadonlyOptional

ReadonlystaticPath

ReadonlyUUID

Readonlyversion

cacheRemove

• cacheRemove<B extends BaseObject<B>>(id: Id<B>): void

  Manually removes a key from the cache. This is useful when you need a query removed from the cache before a commit.

  Type Parameters

  • B extends BaseObject<B>

  Parameters

  • id: Id<B>

  Returns void
• cacheRemove(id: string): void

  Convenience method. It just calls B.util.cacheRemove(B.util.toId(id)).

  Parameters

  • id: string

  Returns void

clearCache

• clearCache(): void

  A restricted function that clears this organizations data from the cache. Use carefully, as clearing the Cache will cause immediate slowdowns to an organization.

  Returns void

  Example

  B.clearCache();
  Copy

config

• config(fnc: () => void): void

  Used for updating the running formula.

  Parameters

  • fnc: () => void

  Returns void

createAlert

• createAlert(settings?: AlertSettings): Alert | AlertBuilder

  Create an [[Alert]]. For details see [[AlertBuilder]]. The fields: type, message, and endDate are required.

  Parameters

  • Optionalsettings: AlertSettings

    Settings object contain field necessary to create the Alert. If parameter is not specified a builder is returned.

  Returns Alert | AlertBuilder

  Example

  Create an alert using a settings object.

  const alert = B.createAlert({
    type: 'auto',
    message: 'Hello World',
    endDate: B.time.Instant.now()
  });
  Copy

  Example

  Create an alert using a builder.

  const alert = B.createAlert()
    .type('signature')
    .message('Hello World')
    .endDate(B.time.Instant.now())
    .create();
  Copy

disableChangeHistory

• disableChangeHistory(fnc: () => void): void

  Disables the saving of Change History

  Parameters

  • fnc: () => void

  Returns void

  Example

  B.disableChangeHistory(() => {
    //Do updates here and change history will not be saved.
  });
  Copy

email

• email(settings?: EmailSettings): Email

  Creates an [[Email]] object to send an email.

  Parameters

  • Optionalsettings: EmailSettings

  Returns Email

  Example

  B.email({
    to: 'user@email.host', 
    subject: 'test', 
    text: 'Hello World' 
  }).send();
  Copy

  Example

  B.email()
    .to('user@email.host')
    .subject('test')
    .text('Hello World')
    .send();
  Copy

hashMap

• hashMap<U, T>(): Java.Map<U, T>

  Returns a java HashMap<U, T>

  Type Parameters

  • U
  • T

  Returns Java.Map<U, T>

hashSet

• hashSet<T>(): Set<T>

  Returns a java HashSet

  Type Parameters

  • T

  Returns Set<T>

isDebugging

• isDebugging(): boolean

  Returns true if the current users is debugging the current formula.

  Returns boolean

isId

• isId(id: string): boolean

  Test whether a string is an [[Id]] string

  Parameters

  • id: string

    The string to test

  Returns boolean

  Example

  const isId = B.isId('test'); // false
  Copy

isValidJson

• isValidJson(potentialJsonString: string): boolean

  Tests the given string and determines if it is valid JSON.

  Parameters

  • potentialJsonString: string

  Returns boolean

  Example

  const isValid = B.util.isValidJson("{\"some\":\"thing\"}");
  Copy

map

• map<T>(map?: { [key: string]: T }): Java.Map<String, T>

  Turns a javascript Object into a Java.Map<String, T>

  Type Parameters

  • T

  Parameters

  • Optionalmap: { [key: string]: T }

  Returns Java.Map<String, T>

mapToObject

• mapToObject<T>(map: Map<String, T>): { [key: string]: T }

  Converts a Map<string, T> to an object.

  Type Parameters

  • T

  Parameters

  • map: Map<String, T>

  Returns { [key: string]: T }

newBigDecimal

• newBigDecimal(value: string | number): BigDecimal

  Creates a new java BigDecimal object from the given value.

  Parameters

  • value: string | number

  Returns BigDecimal

  Example

  const bigDecimal = B.util.newBigDecimal("123.45");
  Copy

newBigInteger

• newBigInteger(value: string | number): BigInteger

  Creates a new java BigInteger object from the given value.

  Parameters

  • value: string | number

  Returns BigInteger

  Example

  const bigInteger = B.util.newBigInteger("123456789012345678901234567890");
  Copy

newCalendar

• newCalendar(instant?: InstantOrDate): Calendar

  Returns a new Calendar object with the current time.

  Parameters

  • Optionalinstant: InstantOrDate

  Returns Calendar

newProperties

• newProperties(
      map?: { [key: string]: any } | Java.Map<any, any>,
  ): Java.Map<any, any>

  Returns a Java Properties Object

  Parameters

  • Optionalmap: { [key: string]: any } | Java.Map<any, any>

  Returns Java.Map<any, any>

runningScriptId

• runningScriptId(): string

  Provides you the id of the currently running Script

  Returns string

secretToEverybody

• secretToEverybody(): any

  Super User Only.

  Returns any

shlink

• shlink(settings?: ShlinkSettings): Shlink

  Creates an [[Shlink]] object to generate a short link.

  Parameters

  • Optionalsettings: ShlinkSettings

  Returns Shlink

sleep

• sleep(duration: number): void

  Delays the continued execution of this thread for the specified number of milliseconds. While this method certainly has its uses, it is generally not recommended for use in most scripts; since it is easy to be tempted to use it to "bandaid" design flaws.

  Parameters

  • duration: number

  Returns void

  Example

  console.log("I'm executed now");
  B.delay(10000);
  console.log("I'm executed ten seconds later");
  Copy

text

• text(settings?: TextSettings): TextMessage

  Creates an [[TextMessage]] object to send an Text.

  Parameters

  • Optionalsettings: TextSettings

  Returns TextMessage

  Example

  const ptoDate = pto.fields.date.val();
  const mPhone = contactInfo.fields.phone.val();
  B.util.text({
  	message: 'Your PTO ${ptoDate} was approved',
  	to: mPhone,
  	unit: pto.formRecord().record().unit().id().longId(),
  	id: contactInfo.id().toString()
  }).send();
  Copy

toAltId

• toAltId<B extends BaseObject<B>>(
      name: string,
      value: string,
      classType: string | number,
  ): AltId<B>

  Convert the name and value and the class type to an [[AltId]]

  Type Parameters

  • B extends BaseObject<B>

  Parameters

  • name: string

    The AltId's name.
  • value: string

    The AltId's value.
  • classType: string | number

    Value representing the class type of AltId

  Returns AltId<B>

  Example

  const altid = B.toAltId('animal', 'dog', 222222);
  Copy

  Example

  const altid = B.toAltId('animal', 'dog', 'myassn.user.User');
  Copy

toAnyId

• toAnyId<B extends BaseObject<B>>(
      IdOrSortId: string,
      classIfIdIsShortId: string | number,
  ): Id<B>

  If a short id is passed it uses the classIfIdIsShortId to identify its class. Otherwise what ever class stored in the id is used.

  Type Parameters

  • B extends BaseObject<B>

  Parameters

  • IdOrSortId: string

    Value representing an full or short id.
  • classIfIdIsShortId: string | number

  Returns Id<B>

  Example

  const id = B.toAnyId('5', 222222);
  Copy

  Example

  const id = B.toAnyId('5', 'myassn.user.User');
  Copy

toHostObject

• toHostObject(): any

  Does it best to change the value to a Host Object. A conversion will be tried for Objects and Arrays. If it or a member can't be converted then toString() will be used for the value.

  Returns any

toId

• toId<B extends BaseObject<B>>(id: string, classType?: string | number): Id<B>

  Convert a full or short id and its class type to an [[Id]]

  Type Parameters

  • B extends BaseObject<B>

  Parameters

  • id: string

    Value representing an full or short id.
  • OptionalclassType: string | number

    Required when id represents a short id.

  Returns Id<B>

  Example

  const id = B.toId('222222___5');
  Copy

  Example

  const id = B.toId('5', 222222);
  Copy

  Example

  const id = B.toId('5', 'myassn.user.User');
  Copy

toIdOrNull

• toIdOrNull<B extends BaseObject<B>>(id: string): Id<B>

  Convert a full or short id and its class type to an Id object, or null if it doesn't exist.

  Type Parameters

  • B extends BaseObject<B>

  Parameters

  • id: string

    string representing a full id.

  Returns Id<B>

  Example

  const id = B.toIdOrNull('222222___5');
  Copy

uuid

• uuid(): string

  Returns a UUID/GUID string. This is the same as calling B.util.UUID.randomUUID().toString();

  Returns string