Table of Contents

Interacting with Profile Manager

The ProfileHelper class can be used in code to interact with profile definitions, profile instances, and profile parameters.

To instantiate a ProfileHelper, a callback to SLNet needs to be provided:

// In an automation script
using Skyline.DataMiner.Net.Profiles;

var helper = new ProfileHelper(engine.SendSLNetMessages);

// In an ad hoc data source
var helper = new ProfileHelper(gqiDms.SendMessages);

// In a connector QAction
var helper = new ProfileHelper(protocol.SLNet.SendMessages);
Note

When an error happens during the handling of profile objects, an exception of type CrudFailedException is thrown. This exception contains TraceData providing more information about the error (see Errors when interacting with profiles). This applies to all CRUD operations shown in the examples below, but not for bulk operations, for which partial success is possible. For those, GetTraceDataLastCall needs to be used to retrieve the trace data of the last call.

Creating profile parameters

var symbolRateParameter = new Parameter(Guid.NewGuid())
{
    Name = "Symbol rate",
    Type = Parameter.ParameterType.Number,
    Units = "MS/s",
    DefaultValue = new ParameterValue
    {
        Type = ParameterValue.ValueType.Double,
        DoubleValue = 5,
    },
    Categories = ProfileParameterCategory.Configuration,
};

var modulationTypeParameter = new Parameter(Guid.NewGuid())
{
    Name = "Modulation Type",
    Type = Parameter.ParameterType.Text,
    Discretes = new List<string> { "QPSK", "QAM16", "QAM64", "QAM256" },
    DefaultValue = new ParameterValue
    {
        Type = ParameterValue.ValueType.String,
        StringValue = "QAM256",
    },
    Categories = ProfileParameterCategory.Configuration,
};

symbolRateParameter = helper.ProfileParameters.Create(symbolRateParameter);
modulationTypeParameter = helper.ProfileParameters.Create(modulationTypeParameter);

Retrieving profile parameters

var modulationTypeParameter = helper.ProfileParameters.Read(ParameterExposers.Name.Equal("Modulation Type")).FirstOrDefault();

Updating profile parameters

modulationTypeParameter.DefaultValue.StringValue = "QAM64";
modulationTypeParameter = helper.ProfileParameters.Update(modulationTypeParameter);

Bulk updating profile parameters

modulationTypeParameter.DefaultValue.StringValue = "QPSK";
symbolRateParameter.DefaultValue.DoubleValue = 7.5;
var updatedParameters = helper.ProfileParameters.AddOrUpdateBulk(modulationTypeParameter, symbolRateParameter);
Note

The AddOrUpdateBulk method can be used to create or update multiple profile parameters in one call. If a parameter with the same ID already exists, it is updated; otherwise, a new parameter is created. Similar AddOrUpdateBulk methods are also available for profile definitions and profile instances.

Deleting profile parameters

helper.ProfileParameters.Delete(modulationTypeParameter);

Creating profile definitions

var profileDefinition = new ProfileDefinition(Guid.NewGuid())
{
    Name = "Decoding Definition",
    Description = "Profile definition for decoding settings",
};
profileDefinition.ParameterIDs.Add(symbolRateParameter.ID);
profileDefinition.ParameterIDs.Add(modulationTypeParameter.ID);

profileDefinition = helper.ProfileDefinitions.Create(profileDefinition);

Reading profile definitions

var profileDefinition = helper.ProfileDefinitions.Read(ProfileDefinitionExposers.Name.Equal("Decoding Definition")).FirstOrDefault();

Updating profile definitions

profileDefinition.Description = "Updated description";
profileDefinition = helper.ProfileDefinitions.Update(profileDefinition);

Deleting profile definitions

helper.ProfileDefinitions.Delete(profileDefinition);

Creating profile instances

var profileInstance = new ProfileInstance(Guid.NewGuid())
{
    Name = "Decoding Instance",
    Description = "Profile instance for decoding settings",
    AppliesTo = profileDefinition,
    Values = new ProfileParameterEntry[]
    {
        new ProfileParameterEntry
        {
            Parameter = symbolRateParameter,
            Value = new ParameterValue
            {
                Type = ParameterValue.ValueType.Double,
                DoubleValue = 6,
            },
        },
        new ProfileParameterEntry
        {
            Parameter = modulationTypeParameter,
            Value = new ParameterValue
            {
                Type = ParameterValue.ValueType.String,
                StringValue = "QAM16",
            },
        },
    },
};

profileInstance = helper.ProfileInstances.Create(profileInstance);

Reading profile instances

var profileInstance = helper.ProfileInstances.Read(ProfileInstanceExposers.Name.Equal("Decoding Instance")).FirstOrDefault();

Updating profile instances

profileInstance.Values[0].Value.DoubleValue = 10;
profileInstance = helper.ProfileInstances.Update(profileInstance);

Deleting profile instances

helper.ProfileInstances.Delete(profileInstance);

Errors when interacting with profiles

Error reason Description Available properties
ModuleNotInitialized ProfileManager is not initialized yet. None.
InvalidServiceProfileDefinitionLink The linked service profile definition does not exist or is not valid because of existing service profile instances. - ProfileDefinition: The profile definition you attempted to delete or update.
- ServiceProfileDefinitionID: The ID of the service profile definition that did not exist or was invalid.
- ProfileInstanceIDs: The IDs of profile instances that reference a service profile instance that is no longer compatible with the new service profile definition.
InvalidServiceProfileInstanceLink The linked service profile instance does not exist or is not valid because of the service profile definition of the profile definition. - ProfileInstance: The profile instance you attempted to delete or update.
- ServiceProfileInstanceID: The ID of the service profile instance that did not exist or was invalid.
- ServiceProfileDefinitionID: The ID of the service profile definition configured on the profile definition of the profile instance, which caused the service profile instance to be invalid.
InvalidMediationSnippetID When creating or updating a profile parameter, the linked mediation snippet does not exist. MediationSnippetIDs: The IDs of mediation snippets that could not be found.
InvalidParameterOnTableDefinition One of the parameters specified in the table definition does not belong to the profile definition. - ProfileDefinition: The profile definition you attempted to create or update.
- ProfileParameterID: The ID of the profile parameter that was not found in the profile definition.
EmptyTableDefinition One of the table definitions specified in the profile definition did not contain any columns. ProfileDefinition: The profile definition you attempted to create or update.
InvalidValueReference The profile instance references a value that could not be resolved. - ProfileInstance: The profile instance with the invalid value reference.
- ProfileParameterID: The ID of the profile parameter containing the invalid value reference.
RemovedProfileParameterInUse The profile definition removes a profile parameter while at least one profile instance exists that is dependent on that profile definition parameter. - ProfileDefinition: The profile definition requesting parameter removal.
- ProfileInstanceIDs: The IDs of profile instances affected by the removal of parameters from their associated profile definition.
ProfileInstanceChangedType The IsValueCopy property changed value while the profile instance was edited. ProfileInstanceID: The ID of the profile instance.
Improve this page