Class OmniScriptAccess

Enhance OmniScript records by attaching their related element records. This creates a complete representation of the OmniScript with its structure and components.

This method is useful when you need to process an OmniScript's full definition, including all its elements, their hierarchies, and property sets.

Example

// Attach elements to a single script
const script = await omniScriptAccess.find('a1r3X000000ABCDEFG');
const scriptWithElements = await omniScriptAccess.attachElements(script);
console.log(`Script has ${scriptWithElements.elements.length} elements`);
Copy

Example

// Attach elements to multiple scripts at once (more efficient)
const scripts = await omniScriptAccess.filter({ type: 'Account' });
const scriptsWithElements = await omniScriptAccess.attachElements(scripts);
scriptsWithElements.forEach(script => {
  console.log(`${script.type}/${script.subType} has ${script.elements.length} elements`);
});
Copy

Retrieve OmniScript elements matching the specified filter criteria. This method queries both OmniProcess and OmniScript element records and combines the results.

Example

// Get all elements from a specific script
const scriptElements = await omniScriptAccess.elements({
  scriptId: 'a1r3X000000ABCDEFG'
});
Copy

Example

// Get all OmniScript elements (embedded scripts) from active scripts
const embeddedScripts = await omniScriptAccess.elements({
  type: 'OmniScript',
  active: true
});
Copy

Example

// Get all Step elements from multiple scripts
const steps = await omniScriptAccess.elements({
  scriptId: ['a1r3X000000ABCDEFG', 'a1r3X000000HIJKLMN'],
  type: 'Step'
});
Copy

Filter OmniScripts based on specified criteria. This method searches across both OmniProcess and OmniScript SObjects and returns matching records.

Example

// Find all active scripts of a specific type
const activeScripts = await omniScriptAccess.filter({
  type: 'Account',
  active: true
});
Copy

Example

// Find all versions of a specific script
const scriptVersions = await omniScriptAccess.filter({
  type: 'Account',
  subType: 'Creation',
  language: 'English'
});
Copy

Example

// Find scripts with their elements
const scriptsWithElements = await omniScriptAccess.filter(
  { type: 'Account' }, 
  { withElements: true }
);
Copy

Find a specific OmniScript record based on the provided identifier. This method looks through both OmniProcess and OmniScript SObjects and returns the matching record. If multiple records match the criteria, it will return the first one found (typically the one with the highest version number).

Throws

Error if no matching OmniScript record is found

Example

// Find script by Salesforce record ID
const scriptById = await omniScriptAccess.find('a1r3X000000ABCDEFG');
Copy

Example

// Find active version of a script by type information
const activeScript = await omniScriptAccess.find({
  type: 'Account',
  subType: 'Creation',
  language: 'English',
  active: true
});
Copy

Example

// Find script with all its elements
const scriptWithElements = await omniScriptAccess.find(
  'a1r3X000000ABCDEFG',
  { withElements: true }
);
Copy

Find active scripts that depend on the given script. This method is useful when you need to know which scripts use the provided script as an embedded subcomponent.

When a script is configured as reusable, it can be embedded in other scripts. This method helps identify those parent scripts that would be affected by changes to the given script.

Example

// Find which active scripts are using a reusable script
const dependentScriptIds = await omniScriptAccess.findActiveDependentScripts({
  type: 'ReusableComponent',
  subType: 'Address',
  language: 'English'
});

// Then you can load those scripts if needed
const dependentScripts = await Promise.all(
  dependentScriptIds.map(id => omniScriptAccess.find(id))
);
Copy

Get all activated template records for the specified template names. This method retrieves Vlocity UI Templates that are used by OmniScripts, primarily for custom Lightning Web Components or custom HTML templates.

This method only returns templates that are marked as active in the org.

Example

// Find active templates used in a script
const templateNames = ['MyCustomTemplate', 'CommonHeader', 'Footer'];
const templates = await omniScriptAccess.findActiveTemplates(templateNames);

if (templates.has('MyCustomTemplate')) {
  const template = templates.get('MyCustomTemplate');
  console.log(`Template HTML: ${template.html}`);
} else {
  console.log('Template not found or not active');
}
Copy