Class Organization

Creates a Unit

Example

const newUnit = unit.addUnit(name, email, contactName, contactAddress, contactPhone, contactEmail);```
Copy

Creates a Unit

Example

const pharmacyRepID = unit.addUnit({unitName: 'New Unit'});```
Copy

An object of alternate ids for this object, with values as [[AltId]]

Example

// you've marked certain forms with the FID of deprecated and want to filter for those
const warningMessage = baseObject.altIdsObject().FID.value().includes('deprecated') && 'Please use a different form';
Copy

An object of alternate ids for this object, with values as strings

Example

// you've marked certain forms with the FID of deprecated and want to filter for those
const warningMessage = baseObject.altIds().FID.includes('deprecated') && 'Please use a different form';
Copy

An array of alternate ids for this object.

Example

// you've marked certain forms with the FID of deprecated and want to filter for those
const warningMessage = baseObject.altIds().FID.includes('deprecated') && 'Please use a different form';
Copy

Same as calling optAncestor(var).orElse(null)

If this object is a Collection it returns it as an array. The majority of objects in the system are Collections. For most objects, this is the same as calling [[children]].

Example

const ids = obj.asArray().map(ob => ob);
Copy

Get the children of the object. This retrieval goes one level deep.

Example

const childrenNames = obj.children().map(child => child.displayName());
Copy

Gets the contact address that is set in Unit Information page.

Example

See [[contactName]]
Copy

Sets the Organization's contact's address.

Gets the contact email that is set in Unit Information page.

Example

B.email({
  to: unit.contactEmail(),
  subject: 'Updates Discussion',
  text: 'Please join us for a discussion about upcoming updates being deployed a week from today.',
}).send()
Copy

Sets the Organization's contact's email.

Gets the contact name that is set in Unit Information page.

Example

• 
  Copy

// assumes you have an array of units

• const contactInfos = units.map(unit => {return {
• unit: unit.Id(),
• unitName: unit,
• name: unit.contactName(),
• address: unit.contactAddress(),
• phone: unit.contactPhone(),
• email: unit.contactEmail(),
• }})

Copy

Sets the Organization's contact's name.

Gets the contact phone that is set in Unit Information page.

Example

See [[contactName]]
Copy

Sets the Organization's contact's phone.

The "created at" timestamp of this object.

Example

const createdAt = `<div class="created-at">${baseObject.created()}</div>`;
Copy

The creator of this object.

Example

alert(`Guess who created this. It was ${baseObject.creator().fullName()}. They are to blame.`);
Copy

Gets the Default Domain configured in the Domain Manager for this unit.

Example

// assumes you have an array of units for your org
const domains = units.map(u => {return {name: u, domain: u.defaultDomain()}});
Copy

Deletes this group Entry data, with the option to additionally delete the underlaying entries.

Deletes the group Entry data with the passed id, preserving the underlaying entries

Returns a delete URL for this object, else a blank string. Following the URL will delete the object, so proceed with caution.

Example

const deleteBtn = `<button data-href="${baseObject.deleteUrl()}">Go to ${baseObject.displayName()}</button>;
Copy

The deleted children of this object. Only looks one level deep. E.g. a form's deleted children could include fields and form entries. A folder's deleted children could include folders, forms, and formulas, but not any of those forms' entries.

Example

const deleted = baseObject.deletedChildren();
Copy

Gets the description that is set in Unit Information page.

Example

// assumes you have an array of descrptions for your org
const descrptions = descrptions.map(d => {return {name: d, domain: d.description()}});
Copy

The default display name of this object. For the most part, this is the same as calling toString(), which is the same as inserting the object into a string.

Example

The following assumes you have already aggregated a selection of baseObjects into an array

const displayNames = [];
for (const o of baseObjects) displayNames.push(o.displayName());
const namesList = `<ul><li>${displayNames.join('</li><li>')}</li></ul>`;
Copy

Sets the Display Name.

Gets the domain url.

Returns an edit URL for this object, else a blank string.

Example

const editBtn = `<button data-href="${baseObject.editUrl()}">Go to ${baseObject}</button>`;
Copy

Gets an array of all the object's ancestors.

Example

const numberOfAncestors = obj.getAncestors().length;
Copy

Gets the HQ URL for the unit.

Deprecated

There should be no new development in HQ sites.

Example

const hqURL = unit.hqUrl();
Copy

The [[Id]] of this object bounded to T.

Example

const displayDiv = `<div class="object-card" id="${baseObject.id()}">
  <div class="title">${baseObject}</div>
  <div class="body">Hello World!</div>
</div>;
Copy

Returns whether the object is locked or not.

Deprecated

Part of the [[Lock]] API.

Example

const isLocked = baseObject.isLocked();
Copy

Returns whether the object is pending a lock or not.

Deprecated

Part of the [[Lock]] API.

Example

const isPendingLock = baseObject.isPendingLock();
Copy

Returns whether the object is pending an unlock or not.

Deprecated

Part of the [[Lock]] API.

Example

const lockPendingUnlock = baseObject.isPendingUnLock();
Copy

Returns the Local Cache object for this Thread/Base Object.

Same as calling optLock().orElse(null)

Gets the Manage URL for the unit.

Example

const siteURLs = `<a href="${unit.manageUrl()}">Manage site</a><a href="${unit.hqUrl()}">Legacy Site</a>`;
Copy

The modified date of this object.

Example

const isModified = baseObject.modified();
Copy

The [[User]] that last modified this object.

Example

const modifierName = baseObject.modifier().fullName();
Copy

A [[Java.Optional]] of the ancestor with the specific class.

Example

const ancestors = obj.optAncestor(1000001).ifPresent(a => console.log('${a} exists'));
Copy

Returns the [[Lock]]

Deprecated

Part of the [[Lock]] API.

Example

const lockExpire = baseObject.optLock();
Copy

A [[Java.Optional]] of the current object's parent object.

Example

const ancestors = obj.optAncestor(1000001).ifPresent(a => console.log('${a} found'));
Copy

Same as calling optParent(var).orElse(null)

Gets the pharmacy id that is set in Unit Information page.

Example

const pharmacyID = unit.pharmacyId();
Copy

Gets the pharmacy rep id that is set in Unit Information page.

Example

const pharmacyRepID = unit.pharmacyRepId();
Copy

Gets the primary [[Relate.RecordContainer]] for the Unit. This holds all of the [[Relate.Record]]s for the Unit. It's used, e.g., on the Change Unit page.

Example

const recordContainerId = unit.primaryRecordContainer().id()
Copy

Reset the current object so that it is cleared from the cache and looked up from the database.

Sets the units ability to show a manage link

Gets the support email that is set in Unit Information page.

Example

B.email({
  to: unit.supportEmail(),
  subject: 'We have a problem',
  text: 'Need your help. Please reply ASAP.',
}).send()
Copy

Sets the Organization's Email.

The [[Id]] or [[AltId]] that the system deems most relevant.

Example

const displayDiv = `<div class="object-card" id="${baseObject.topId()}">
  <div class="title">${baseObject}</div>
  <div class="body">Hello World!</div>
</div>;
Copy

Returns the bluestep.js classpath for the current object.

Example

const isBool = testForm.fields.mysteryField.typeName().toLowerCase().includes('boolean')
Copy

Makes changes to the database for this object

The version of this object or empty string if it doesn't exist.

Example

const version = baseObject.version();
Copy

The versions of this object.

Example

const versions = baseObject.versions();
Copy

Returns a view URL for this object, if it has one. This value is always a relative URL, meaning it does not contain the protocol prefix or domain name such as http://xyz.bluestep.net.

Example

const viewBtn = `<button data-href="${baseObject.viewUrl()}">Go to ${baseObject.displayName()}</button>;
Copy

Creates a new group entry data object and applies it to a specific unit.

    const { request, response } = B.net;

const unitId = "111000___148502";
allRes.currentUnit(unitId);

allRes[0].unit()
    .addGroupEntryData({
        // id of the 'Group Entry'
        groupEntryId: '530101___1',
        // ids of all residents affected
        recordIds: ['1000002___1154989'],
        // key/value pairs where the key is the formula identifier of the field being updated
        commonFieldsData: { 'homePhone': '(801) 654-5978' }
    });
Copy

Applies updates to a group entry data object. You will get an error if the passed id is not found and/or if you pass fields that don't exist

const { request, response } = B.net;
const unitId = '111000___148502';
allRes.currentUnit(unitId);

allRes[0].unit()
    .updateGroupEntryData({
        groupEntryDataId: '530103___701', // id of the 'Group Entry Data'
        commonFieldsData: { 'homePhone': '(801) 654-5978' } // key/value pairs
    });
Copy