Class CRMScriptEntity

CRM Scripts - stored in the ejScript table, including source code.

Carrier object for CRMScriptEntity. Services for the CRMScriptEntity Carrier is available from the ICRMScriptAgent.

Syntax

public class CRMScriptEntity : Carrier

Examples

Get CRMScriptEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var cRMScriptEntity = agent.GetCRMScriptEntity( 123 );
 }

Find all CRMScriptEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ejscripts", "...", null, "getAllRows eq 1", null, 0, 100 );

Constructors

CRMScriptEntity()

Default constructor

Declaration

public CRMScriptEntity()

Examples

Get CRMScriptEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var cRMScriptEntity = agent.GetCRMScriptEntity( 123 );
 }

Find all CRMScriptEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ejscripts", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Properties

AccessKey

Access key used to run this script on the customer pages

Declaration

public virtual string AccessKey { get; set; }

Property Value

Type	Description
String

Examples

Get CRMScriptEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var cRMScriptEntity = agent.GetCRMScriptEntity( 123 );
 }

Find all CRMScriptEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ejscripts", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Description

Optional description of what this script is used for.

Declaration

public virtual string Description { get; set; }

Property Value

Type	Description
String

Examples

Get CRMScriptEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var cRMScriptEntity = agent.GetCRMScriptEntity( 123 );
 }

Find all CRMScriptEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ejscripts", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

EjscriptId

Primary key

Declaration

public virtual int EjscriptId { get; set; }

Property Value

Type	Description
Int32

Examples

Get CRMScriptEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var cRMScriptEntity = agent.GetCRMScriptEntity( 123 );
 }

Find all CRMScriptEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ejscripts", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

HierarchyId

The script is inside this hierarchy folder

Declaration

public virtual int HierarchyId { get; set; }

Property Value

Type	Description
Int32

Examples

Get CRMScriptEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var cRMScriptEntity = agent.GetCRMScriptEntity( 123 );
 }

Find all CRMScriptEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ejscripts", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

HtmlOutput

True if this script will return HTML output

Declaration

public virtual short HtmlOutput { get; set; }

Property Value

Type	Description
Int16

Examples

Get CRMScriptEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var cRMScriptEntity = agent.GetCRMScriptEntity( 123 );
 }

Find all CRMScriptEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ejscripts", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

IncludeId

A unique name used for including this script in another

Declaration

public virtual string IncludeId { get; set; }

Property Value

Type	Description
String

Examples

Get CRMScriptEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var cRMScriptEntity = agent.GetCRMScriptEntity( 123 );
 }

Find all CRMScriptEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ejscripts", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Includes

The unique ids of all depencies of this script (all resolved includes)

Declaration

public virtual int[] Includes { get; set; }

Property Value

Type	Description
Int32[]

Examples

Get CRMScriptEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var cRMScriptEntity = agent.GetCRMScriptEntity( 123 );
 }

Find all CRMScriptEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ejscripts", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Name

A description of this script

Declaration

public virtual string Name { get; set; }

Property Value

Type	Description
String

Examples

Get CRMScriptEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var cRMScriptEntity = agent.GetCRMScriptEntity( 123 );
 }

Find all CRMScriptEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ejscripts", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Registered

Registered when in UTC.

Declaration

public virtual DateTime Registered { get; set; }

Property Value

Type	Description
DateTime

Examples

Get CRMScriptEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var cRMScriptEntity = agent.GetCRMScriptEntity( 123 );
 }

Find all CRMScriptEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ejscripts", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

RegisteredAssociateId

Registered by whom

Declaration

public virtual int RegisteredAssociateId { get; set; }

Property Value

Type	Description
Int32

Examples

Get CRMScriptEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var cRMScriptEntity = agent.GetCRMScriptEntity( 123 );
 }

Find all CRMScriptEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ejscripts", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

ScriptType

The type/language of this script

Declaration

public virtual ScriptType ScriptType { get; set; }

Property Value

Type	Description
ScriptType

Examples

Get CRMScriptEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var cRMScriptEntity = agent.GetCRMScriptEntity( 123 );
 }

Find all CRMScriptEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ejscripts", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Source

The script

Declaration

public virtual string Source { get; set; }

Property Value

Type	Description
String

Examples

Get CRMScriptEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var cRMScriptEntity = agent.GetCRMScriptEntity( 123 );
 }

Find all CRMScriptEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ejscripts", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

SourceCode

Contains the source code of the script

Declaration

public virtual string SourceCode { get; set; }

Property Value

Type	Description
String

Examples

Get CRMScriptEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var cRMScriptEntity = agent.GetCRMScriptEntity( 123 );
 }

Find all CRMScriptEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ejscripts", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

SourceMaps

The source maps for this script

Declaration

public virtual CRMScriptSourceMap[] SourceMaps { get; set; }

Property Value

Type	Description
CRMScriptSourceMap[]

Examples

Get CRMScriptEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var cRMScriptEntity = agent.GetCRMScriptEntity( 123 );
 }

Find all CRMScriptEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ejscripts", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

UniqueIdentifier

Global unique identifier, accross customers/tenants

Declaration

public virtual string UniqueIdentifier { get; set; }

Property Value

Type	Description
String

Examples

Get CRMScriptEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var cRMScriptEntity = agent.GetCRMScriptEntity( 123 );
 }

Find all CRMScriptEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ejscripts", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Updated

Last updated when in UTC.

Declaration

public virtual DateTime Updated { get; set; }

Property Value

Type	Description
DateTime

Examples

Get CRMScriptEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var cRMScriptEntity = agent.GetCRMScriptEntity( 123 );
 }

Find all CRMScriptEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ejscripts", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

UpdatedAssociateId

Last updated by whom

Declaration

public virtual int UpdatedAssociateId { get; set; }

Property Value

Type	Description
Int32

Examples

Get CRMScriptEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var cRMScriptEntity = agent.GetCRMScriptEntity( 123 );
 }

Find all CRMScriptEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ejscripts", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

ValidationResult

The result of a validation of a TypeScript when saving

Declaration

public virtual CRMScriptResult ValidationResult { get; set; }

Property Value

Type	Description
CRMScriptResult

Examples

Get CRMScriptEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var cRMScriptEntity = agent.GetCRMScriptEntity( 123 );
 }

Find all CRMScriptEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ejscripts", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration

public override string ToString()

Returns

Type	Description
String	The carrier contents.

Examples

Get CRMScriptEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var cRMScriptEntity = agent.GetCRMScriptEntity( 123 );
 }

Find all CRMScriptEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ejscripts", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

ToString(String)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration

public string ToString(string prefix)

Parameters

Type	Name	Description
String	prefix	The line prefix (typically used for indenting)

Returns

Type	Description
String	The carrier contents.

Examples

Get CRMScriptEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CRMScriptAgent();
    var cRMScriptEntity = agent.GetCRMScriptEntity( 123 );
 }

Find all CRMScriptEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ejscripts", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

See Also

CRMScriptAgent

ICRMScriptAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)