010 Editor

• David Ekers, 
• Lisa Webster, 
• Annemieke Van Straten, 
• Pim Cuijpers, 
• David Richards, 
• Simon Gilbody

x

Identification and Selection of Studies

We included studies identified in previous meta-analyses [5], [6] and cross referenced with on additional BA review [7]. In addition we searched a database of psychotherapy studies of depression. This database has been used in a series of published meta-analysis examining depression (nkc.com.pk) and has been described in detail elsewhere [8]. It is updated yearly using a systematic and comprehensive review of all published evidence ( to January ) and included 14, abstracts (3, from pubmed, 2, from psycinfo, 4, from embase, and 3, from the Cochrane Central Register of Controlled Trials). Reference lists of identified studies and meta-analyses were examined to ensure no studies had been missed. Finally key researchers in BA were contacted to identify any missed studies or studies in press.

Inclusion Criteria

We included all randomised controlled trials for adult (≥16 years) patients with a primary diagnosis of depression who were treated in community or in-patient settings with BA. BA was defined as a behaviourally oriented time limited psychotherapeutic intervention including key elements of self-monitoring and activity scheduling. As BA is a relatively recent term used to describe this intervention we also included studies of behavioural therapy for depression if self-monitoring and activity scheduling were core elements of the intervention. Comparators consisted of a range of waiting list, placebo and usual care. We did not explore the comparative effectiveness of BA with other psychotherapies as this has been updated in other recent reviews [3], [9][9], [10]. We also explored studies where BA had been compared with antidepressant medication. This comparison has been missing in previous reviews and represents an important consideration as antidepressants remain the most commonly received treatment for depression [11]. We included studies in any language to reduce the risk of potential publication bias.

Studies excluded were those which included participants with psychosis or bipolar disorder, substance misuse problems, cognitive impairment or without depression as a primary diagnosis.

Study Level Moderators

Subgroup analyses were conducted to explore any potential dispersion across results. We investigated the moderating effects of:

• Group/Individual therapy
• Clinical/non clinical populations (i.e. student samples)
• Recruitment setting/approach
• Baseline depression severity
• Method of depression categorisation at assessment
• Level of therapist experience (psychotherapist/psychologist compared to specifically trained non specialist)
• Control type
• Number of sessions
• Quality of included studies.

In addition we explored the type of behavioural treatment employed in the study and if these were associated with effect. We examined the number of the elements currently considered core to BA (self-monitoring, activity scheduling, functional analysis, values assessment) included in each study as a continuous variable and if the treatment were considered simple BA (predominantly self-monitoring and scheduling) or complex BA (self-monitoring, scheduling plus additional behavioural components such as functional analysis and/or values focussed interventions). This subgroup analysis represented an important consideration as more complex BA studies have been excluded from recent reviews [9] as they were deemed to represent ‘third wave CBT’. This classification is not commonly accepted however and careful consideration of the cumulative effect of intervention components would represent useful new data relevant to this debate.

Outcome Measures

Our primary outcome measure was depression symptom level, collected either via self-rated or via clinician-rated measures. Where studies included multiple symptom measures, all data were entered and the mean effect was calculated, so that each study provided one estimate of effect.

Quality Assessment

Quality of studies was rated according to the Cochrane Collaboration’s Tool for Assessing Risk of Bias [12]. The elements used were;

1. Adequate generation of randomisation sequence
2. Allocation concealment
3. Blinding of assessment
4. Dealing with missing data.

Due to the difficulties of blinding participants, therapists and other associated health professionals in psychotherapy studies, this quality factor was excluded. Each study was scored against the above to provide a score of between 0 and 4.

Data Extraction and Sub Group Coding

Two researchers extracted data from each trial post treatment and where possible at follow up. Those data were checked by LW and DE in a series of meetings. Any inconsistencies were referred back to the original text. Missing data were requested from study authors by email. Missing standard deviation (SD) scores were imputed from other relevant studies where these data were not available, with imputations tested in sensitivity analysis as per accepted procedures [13]. Finally extracted data were reviewed in a group meeting (DE, LW, A VS and PC) where consensus was reached.

Meta-analyses

Effect size was calculated using the Comprehensive Meta-analysis (version ) [14] computer program using standardised mean difference (SMD) with value ranges of small (0–), medium (–) and large ( and above) as per standard convention [15]. This approach allows analysis of the same outcome (depression symptom level) using different scales by subtracting the post-test mean of the intervention group from the post-test mean of the control group and dividing results by the pooled standard deviation. This provided the SMD, a consistent scale across measures of depression symptom level in included studies. Hedges g was reported to adjust for potential small sample bias anticipated in this review. Where studies included two or more measures of depression, all data were entered and the mean effect size was calculated within the CMA program. Where studies reported stratified results (i.e. high/low severity) these were combined using the study as the unit of analysis in CMA to reduce undue influence on heterogeneity. A hierarchy of reported data was used for entry into meta-analysis, with means and standard deviations taking priority, as these were considered the best assessment of outcome. Where these were not reported we used effect size data, dichotomous data or tests of significance in that order of preference. Where studies reported dichotomous outcomes, data were used to calculate a standardised effect size using a logit transformation in CMA. We present pooled data with 95% confidence intervals. As we were including studies across a long time span and number of control conditions we anticipated heterogeneity, and hence calculated effect sizes using a random effects model [16]. The random effects model takes into account both within- and between-study variance. Statistical heterogeneity was examined using the I²statistic for statistical variation across studies [17]. The I²statistic provides a measure of the proportion of dispersion of effects across studies that reflect real differences rather than random error. Benchmark values of 25%, 50% and 75% reflect low, moderate and high heterogeneity respectively and we report with 95% confidence intervals. The I²statistic does not include a test of significance so we calculated the Q statistic and report P values associated with that. In addition, SMDs were translated into number needed to treat (NNT) using accepted formulae [18] to ease interpretation of results from a clinical perspective. NNT indicates the number of patients requiring intervention to achieve one additional positive outcome over a comparator.

Subgroup analyses were conducting using a mixed effects model [14], [19]. This process pools results within groups using a random effects model, and tests for significant difference between subgroups using a fixed effects model. Meta -regression was used for exploration of the moderating impact of continuous variables on effect size indicated by a Z-value and associated p value [14], [19]. We examined the impact of our a priori moderators and type of control condition on effect size. Publication bias was assessed through visual inspection of a funnel plot graph on the primary outcome (post-treatment depression score) for asymmetry. This is an accepted approach, but is subject to inconsistency, with sufficient studies (≥10) being required to differentiate real from spurious asymmetry [20]. In order to counter this problem, an Egger weighted regression test [21] was calculated to quantify potential publication bias, and the trim and fill procedure [14], [19] used to estimate effect size after any such bias was taken into account.

Description of Studies

Twenty five studies compared BA with control treatments with a total of subjects (BA condition N = ; Control condition N = ) matched the inclusion criteria and were included in the current meta-analysis. A summary of the characteristics of the included studies are presented in Table 1. Sixteen studies focused on the general population, four focused on university students, four focused on older adults, and one on women with post-natal depression. Nineteen studies were set in specialist mental health services, four in primary care or physical health care and two were web based. Sixteen studies involved participants contacting the research team, four studies used screening procedures, three studies used referral and two a mixed approach. Nine studies incorporated complex BA as an intervention and the remaining 16 incorporated simple BA. Twelve studies used a structured clinical interview whereas the remaining 13 used other unstructured forms. Ten studies used both clinician and self-rated measures of depression, 11 used only self-rated measures, and four used clinician rated measures. Treatment as usual was used for the control type in six of the studies, waiting list control was used in 15 of the studies, and a psychological placebo intervention was used in three of the studies. One study used both a waiting list and a placebo as control type. The level of therapist varied from specialist in 22 of the studies, and non-specialist in the remaining three. The delivery mode of the therapy was in an individual format in 15 of the studies, a group format in eight and self-help in the remaining two. Baseline depression scores were moderate to severe for 20 of the studies and mild to moderate for four. One study included both mild-moderate and moderate to severe scores. Number of sessions varied between one and Seventeen studies were conducted in the United States, two in Australia, one in Canada, one in Sweden, one in the Netherlands, one in Spain, and two in the UK.

One additional study [89] and three studies also included in the BA vs. control comparison [68], [72], [82], [89] were included in the BA vs. Medication meta-analysis (BA condition n = ; anti-depressant medication n = ). Two studies used SSRI medication ad complex BA [82], [89] with the other two using tri-cyclic medication ad simple BA. Further details of these studies can be seen in table 1.

We generally classed studies as low quality with only seven reporting three or more of our quality standards (see table 2).

Meta-Analysis BA vs. Control Interventions

BA for depression was compared to controls in 25 studies including 31 comparisons and participants. The SMD (g) at post treatment was − (95% CI − to − p< NNT ), representing a large effect size (fig. 2). Sensitivity analysis replacing mid-range imputed standard deviations with lowest and highest observed values had minimal influence on results (g = −, 95% CI − to − and g = − 95% CI − to − respectively). There was moderate between-study heterogeneity of treatment effects beyond what would be expected due to sampling error (Q p I² %). Subgroup analysis was used to explore this dispersion further. We found a significant association with effect size and subgroup in two areas, control type and baseline depression severity. All other subgroup comparisons identified similar SMD across groups (see table 3). Study quality was sub optimal in all but six studies, subgroup analysis indicated no significant relationship between study quality and effect size. The SMD (g) of comparisons in low quality studies at post treatment was − and in high quality studies − with similar levels of statistical heterogeneity (see table 3). The median number of clinical sessions with a therapist was eight (range one to 16). Meta-regression using session number as a mediator resulted in a slope of (95% CI − to , Q _total p = , Q _{session number} p = ), indicating no significant influence on effect size. Meta-regression using BA components as a mediator resulted in a non-significant slope of (95% CI − to , Q _total p = , Q _{session number} p = ), indicating minimal influence on effect size.

Inspection of the funnel plot indicated no evidence of publication bias. Trim and fill procedures supported this observation, suggesting no change in effect sizes when imputation for potential missing data was undertaken. Egger’s test indicated a symmetrical distribution (intercept − 95% CI − to p = ). In 13 (50%) studies with the largest sample sizes an SMD − (− to −) was observed indicating only a limited influence of small studies on the overall estimated effect.

Five studies including eight comparisons and participants provided follow up data between 6–9 months. The SMD (g) at follow up was − (95% CI − to − p< NNT ), representing a medium effect size. There was no evidence of between-study heterogeneity of treatment effects (Q , p , I² 0%).

Meta-analysis BA vs. Antidepressant Medication

BA for depression was compared to antidepressant medication in four studies including participants. The SMD (g) at post treatment was − (95% CI − to − p NNT ), representing a moderate effect size in favour of BA (see fig. 3). There was moderate between-study heterogeneity of treatment effects beyond what would be expected due to sampling error (Q p , I² %). Two studies used SSRI [82], [89] with two studies tricyclic antidepressant medication [68], [72] with no apparent association between drug type and effect size (see table 2). There were insufficient studies to allow further exploration of subgroups or potential publication bias. We conducted sensitivity analysis on study quality by removing the two low quality studies from the analysis [68], [72] resulting in a non-significant effect size in favour of BA of − (95% CI − to p ).

• David Ekers, 
• Lisa Webster, 
• Annemieke Van Straten, 
• Pim Cuijpers, 
• David Richards, 
• Simon Gilbody

x

Identification and Selection of Studies

We included studies identified in previous meta-analyses [5], [6] and cross referenced with on additional BA review [7]. In addition we searched a database of psychotherapy studies of depression. This database has been used in a series of published meta-analysis examining depression (nkc.com.pk) and has been described in detail elsewhere [8]. It is updated yearly using a systematic and comprehensive review of all published evidence ( to January ) and included 14, abstracts (3, from pubmed, 2, from psycinfo, 4, from embase, and 3, from the Cochrane Central Register of Controlled Trials). Reference lists of identified studies and meta-analyses were examined to ensure no studies had been missed. Finally key researchers in BA were contacted to identify any missed studies or studies in press.

Inclusion Criteria

We included all randomised controlled trials for adult (≥16 years) patients with a primary diagnosis of depression who were treated in community or in-patient settings with BA. BA was defined as a behaviourally oriented time limited psychotherapeutic intervention including key elements of self-monitoring and activity scheduling. As BA is a relatively recent term used to describe this intervention we also included studies of behavioural therapy for depression if self-monitoring and activity scheduling were core elements of the intervention. Comparators consisted of a range of waiting list, placebo and usual care. We did not explore the comparative effectiveness of BA with other psychotherapies as this has been updated in other recent reviews [3], [9][9], [10]. We also explored studies where BA had been compared with antidepressant medication. This comparison has been missing in previous reviews and represents an important consideration as antidepressants remain the most commonly received treatment for depression [11]. We included studies in any language to reduce the risk of potential publication bias.

Studies excluded were those which included participants with psychosis or bipolar disorder, substance misuse problems, cognitive impairment or without depression as a primary diagnosis.

Study Level Moderators

Subgroup analyses were conducted to explore any potential dispersion across results. We investigated the moderating effects of:

• Group/Individual therapy
• Clinical/non clinical populations (i.e. student samples)
• Recruitment setting/approach
• Baseline depression severity
• Method of depression categorisation at assessment
• Level of therapist experience (psychotherapist/psychologist compared to specifically trained non specialist)
• Control type
• Number of sessions
• Quality of included studies.

In addition we explored the type of behavioural treatment employed in the study and if these were associated with effect. We examined the number of the elements currently considered core to BA (self-monitoring, activity scheduling, functional analysis, values assessment) included in each study as a continuous variable and if the treatment were considered simple BA (predominantly self-monitoring and scheduling) or complex BA (self-monitoring, scheduling plus additional behavioural components such as functional analysis and/or values focussed interventions). This subgroup analysis represented an important consideration as more complex BA studies have been excluded from recent reviews [9] as they were deemed to represent ‘third wave CBT’. This classification is not commonly accepted however and careful consideration of the cumulative effect of intervention components would represent useful new data relevant to this debate.

Outcome Measures

Our primary outcome measure was depression symptom level, collected either via self-rated or via clinician-rated measures. Where studies included multiple symptom measures, all data were entered and the mean effect was calculated, so that each study provided one estimate of effect.

Quality Assessment

Quality of studies was rated according to the Cochrane Collaboration’s Tool for Assessing Risk of Bias [12]. The elements used were;

1. Adequate generation of randomisation sequence
2. Allocation concealment
3. Blinding of assessment
4. Dealing with missing data.

Due to the difficulties of blinding participants, therapists and other associated health professionals in psychotherapy studies, this quality factor was excluded. Each study was scored against the above to provide a score of between 0 and 4.

Data Extraction and Sub Group Coding

Two researchers extracted data from each trial post treatment and where possible at follow up. Those data were checked by LW and DE in a series of meetings. Any inconsistencies were referred back to the original text. Missing data were requested from study authors by email. Missing standard deviation (SD) scores were imputed from other relevant studies where these data were not available, with imputations tested in sensitivity analysis as per accepted procedures [13]. Finally extracted data were reviewed in a group meeting (DE, LW, A VS and PC) where consensus was reached.

Meta-analyses

Effect size was calculated using the Comprehensive Meta-analysis (version ) [14] computer program using standardised mean difference (SMD) with value ranges of small (0–), medium (–) and large ( and above) as per standard convention [15]. This approach allows analysis of the same outcome (depression symptom level) using different scales by subtracting the post-test mean of the intervention group from the post-test mean of the control group and dividing results by the pooled standard deviation. This provided the SMD, a consistent scale across measures of depression symptom level in included studies. Hedges g was reported to adjust for potential small sample bias anticipated in this review. Where studies included two or more measures of depression, all data were entered and the mean effect size was calculated within the CMA program. Where studies reported stratified results (i.e. high/low severity) these were combined using the study as the unit of analysis in CMA to reduce undue influence on heterogeneity. A hierarchy of reported data was used for entry into meta-analysis, with means and standard deviations taking priority, as these were considered the best assessment of outcome. Where these were not reported we used effect size data, dichotomous data or tests of significance in that order of preference. Where studies reported dichotomous outcomes, data were used to calculate a standardised effect size using a logit transformation in CMA. We present pooled data with 95% confidence intervals. As we were including studies across a long time span and number of control conditions we anticipated heterogeneity, and hence calculated effect sizes using a random effects model [16]. The random effects model takes into account both within- and between-study variance. Statistical heterogeneity was examined using the I²statistic for statistical variation across studies [17]. The I²statistic provides a measure of the proportion of dispersion of effects across studies that reflect real differences rather than random error. Benchmark values of 25%, 50% and 75% reflect low, moderate and high heterogeneity respectively and we report with 95% confidence intervals. The I²statistic does not include a test of significance so we calculated the Q statistic and report P values associated with that. In addition, SMDs were translated into number needed to treat (NNT) using accepted formulae [18] to ease interpretation of results from a clinical perspective. NNT indicates the number of patients requiring intervention to achieve one additional positive outcome over a comparator.

Subgroup analyses were conducting using a mixed effects model [14], [19]. This process pools results within groups using a random effects model, and tests for significant difference between subgroups using a fixed effects model. Meta -regression was used for exploration of the moderating impact of continuous variables on effect size indicated by a Z-value and associated p value [14], [19]. We examined the impact of our a priori moderators and type of control condition on effect size. Publication bias was assessed through visual inspection of a funnel plot graph on the primary outcome (post-treatment depression score) for asymmetry. This is an accepted approach, but is subject to inconsistency, with sufficient studies (≥10) being required to differentiate real from spurious asymmetry [20]. In order to counter this problem, an Egger weighted regression test [21] was calculated to quantify potential publication bias, and the trim and fill procedure [14], [19] used to estimate effect size after any such bias was taken into account.

Description of Studies

Twenty five studies compared BA with control treatments with a total of subjects (BA condition N = ; Control condition N = ) matched the inclusion criteria and were included in the current meta-analysis. A summary of the characteristics of the included studies are presented in Table 1. Sixteen studies focused on the general population, four focused on university students, four focused on older adults, and one on women with post-natal depression. Nineteen studies were set in specialist mental health services, four in primary care or physical health care and two were web based. Sixteen studies involved participants contacting the research team, four studies used screening procedures, three studies used referral and two a mixed approach. Nine studies incorporated complex BA as an intervention and the remaining 16 incorporated simple BA. Twelve studies used a structured clinical interview whereas the remaining 13 used other unstructured forms. Ten studies used both clinician and self-rated measures of depression, 11 used only self-rated measures, and four used clinician rated measures. Treatment as usual was used for the control type in six of the studies, waiting list control was used in 15 of the studies, and a psychological placebo intervention was used in three of the studies. One study used both a waiting list and a placebo as control type. The level of therapist varied from specialist in 22 of the studies, and non-specialist in the remaining three. The delivery mode of the therapy was in an individual format in 15 of the studies, a group format in eight and self-help in the remaining two. Baseline depression scores were moderate to severe for 20 of the studies and mild to moderate for four. One study included both mild-moderate and moderate to severe scores. Number of sessions varied between one and Seventeen studies were conducted in the United States, two in Australia, one in Canada, one in Sweden, one in the Netherlands, one in Spain, and two in the UK.

One additional study [89] and three studies also included in the BA vs. control comparison [68], [72], [82], [89] were included in the BA vs. Medication meta-analysis (BA condition n = ; anti-depressant medication n = ). Two studies used SSRI medication ad complex BA [82], [89] with the other two using tri-cyclic medication ad simple BA. Further details of these studies can be seen in table 1.

We generally classed studies as low quality with only seven reporting three or more of our quality standards (see table 2).

Meta-Analysis BA vs. Control Interventions

BA for depression was compared to controls in 25 studies including 31 comparisons and participants. The SMD (g) at post treatment was − (95% CI − to − p< NNT ), representing a large effect size (fig. 2). Sensitivity analysis replacing mid-range imputed standard deviations with lowest and highest observed values had minimal influence on results (g = −, 95% CI − to − and g = − 95% CI − to − respectively). There was moderate between-study heterogeneity of treatment effects beyond what would be expected due to sampling error (Q p I² %). Subgroup analysis was used to explore this dispersion further. We found a significant association with effect size and subgroup in two areas, control type and baseline depression severity. All other subgroup comparisons identified similar SMD across groups (see table 3). Study quality was sub optimal in all but six studies, subgroup analysis indicated no significant relationship between study quality and effect size. The SMD (g) of comparisons in low quality studies at post treatment was − and in high quality studies − with similar levels of statistical heterogeneity (see table 3). The median number of clinical sessions with a therapist was eight (range one to 16). Meta-regression using session number as a mediator resulted in a slope of (95% CI − to , Q _total p = , Q _{session number} p = ), indicating no significant influence on effect size. Meta-regression using BA components as a mediator resulted in a non-significant slope of (95% CI − to , Q _total p = , Q _{session number} p = ), indicating minimal influence on effect size.

Inspection of the funnel plot indicated no evidence of publication bias. Trim and fill procedures supported this observation, suggesting no change in effect sizes when imputation for potential missing data was undertaken. Egger’s test indicated a symmetrical distribution (intercept − 95% CI − to p = ). In 13 (50%) studies with the largest sample sizes an SMD − (− to −) was observed indicating only a limited influence of small studies on the overall estimated effect.

Five studies including eight comparisons and participants provided follow up data between 6–9 months. The SMD (g) at follow up was − (95% CI − to − p< NNT ), representing a medium effect size. There was no evidence of between-study heterogeneity of treatment effects (Q , p , I² 0%).

Meta-analysis BA vs. Antidepressant Medication

BA for depression was compared to antidepressant medication in four studies including participants. The SMD (g) at post treatment was − (95% CI − to − p NNT ), representing a moderate effect size in favour of BA (see fig. 3). There was moderate between-study heterogeneity of treatment effects beyond what would be expected due to sampling error (Q p , I² %). Two studies used SSRI [82], [89] with two studies tricyclic antidepressant medication [68], [72] with no apparent association between drug type and effect size (see table 2). There were insufficient studies to allow further exploration of subgroups or potential publication bias. We conducted sensitivity analysis on study quality by removing the two low quality studies from the analysis [68], [72] resulting in a non-significant effect size in favour of BA of − (95% CI − to p ).

1. On the Electronic Collection Editor page (Resources > Add Local Electronic Collection), enter the basic collection information.
   

1. Select Save and Continue.
   • If you selected service type None, the Electronic Collection Editor page appears. Continue with step
   • If you selected service type Full Text or Selected Full Text, the Activation tab on the Electronic Service Editor page appears:
     
2. Enter the activation information.

   Field	Description
   Service activation status	Select Available if you want the service to be active, or Not Available otherwise. This field is ignored if either or both of the Active from date / Active until date fields are set.
   Activate new portfolios associated with service automatically?	Select to automatically activate new portfolios when they are added to this service. This option is available for aggregator and selective packages. This option only applies to portfolios with service type Full Text. Portfolios of service type Selected Full Text do not automatically activate even if this option is set to Yes. Selected Full Text portfolios needs to be activated manually.  After changing this setting to Yes, new portfolios are automatically activated, but no change is made to any existing portfolios. Portfolios that were inactive prior to this change remain inactive. When you use this option, the resulting automatically-activated portfolios can be retrieved by using the Portfolio added to auto-active package report type in the Community Zone Updates Task List (Resources > Manage Inventory > Community Zone Updates Task List). See Portfolio added to auto-active package for more information.
   Active from date	A start date for the activation. If no start date is entered, activation starts from the current date (today). The activation from and until date fields override the Service activation status field.
   Active until date	An end date. If no end date is entered, activation continues indefinitely.
   Service temporarily unavailable message	Select Yes or No to generate a service temporarily unavailable message either on the current date or on a specific date (see Service unavailable as of date). Note that this does not deactivate the service. This message is generated for all associated portfolios.
   Service unavailable message as of date	A date for when the service temporarily unavailable message is generated. If not entered, the current date (today) is used.
   Service unavailability reason	The reason to appear in the service temporarily unavailable message. Use the OpenURL Link Resolver to preview on the Electronic Services page what will appear in the discovery interface for patrons.

3. Select the Service Description tab and review or edit the information as described in the table below:
   

   Field	Description
   Service Type	This field has no functional implication. See the Initial Collection table.
   Public description	See the Initial Collection table.
   Internal description	See the Initial Collection table.
   Public description (override)	This field is not currently functional.

4. Select the Linking tab and review or edit the information as described in the Linking Tab Options table below.
   

   Option	Description
   General Linking Information
   Parser	The destination service. (Example: AIP::SCITATION) If the target URL of each portfolio is exactly the value of the jkey = statement in the portfolio parser parameters, use a Bulk::BULK Parser.
   Parser (override)	A parser to override the value in the Parser field.
   Parser parameters	The linking/access information for the service. For example: url1=nkc.com.pk? & url2=nkc.com.pk & url3=nkc.com.pk & agg=sfx
   Parser parameters (override)	An override to the Parser parameters if an alternative one is specified by the service.   To remove the override and restore this field for multiple records in batch, in the Portfolio Loader replace the value of this field with the value “NULL”. For details, see Restore Community Zone linking parameters (remove override of parser).
   URL Type	The type of URL that is used for this service: Dynamic URL – Select a linking URL dynamically at the service level based on the list of conditions defined in the Dynamic URL field. Parser Parameters – An override for the parser’s parameters in the Parser parameters (override) field.
   URL Type (override)	Appears only for collections linked to the Community Zone. If you are the collection contributor, enter a value here to update the collection in the CZ. If you are not the contributor, enter a value here to update your local copy.
   Dynamic URL	A list of IF conditions to determine the service’s linking URL when you select Dynamic URL as the URL Type. Select Test dynamic URL syntax to verify the syntax of the IF statements. For information on dynamic URLs, see Configuring Dynamic URLs for Electronic Collections and Portfolios.
   Linking level	The linking level or unit to which the electronic collection will link such as volume, issue, or article. This field is for information only, it does not have any implications in Alma.
   Linking level (override)	Appears only for collections linked to the Community Zone. If you are the collection contributor, enter a value here to update the collection in the CZ. If you are not the contributor, enter a value here if you want to change the linking level value in your local copy.
   Service is free?	Whether or not the service is free.
   Is free (override)	Appears only for collections linked to the Community Zone. If you are the collection contributor, enter a value here to update the collection in the CZ. If you are not the contributor, enter a value here to update your local copy.
   Crossref supported	This field displays whether or not CrossRef is supported in the Community Zone's electronic service for this resource. See nkc.com.pk for more information regarding the CrossRef DOI (Digital Object Identifier) service. For records linked to the Community Zone, this field is set by Ex Libris in the Community Zone. For local electronic collections, you may select Yes/No. This setting is optional for local electronic collections. When you select Yes, confirm that the parser program that you select supports adding in the DOI to the URL. If it does not, setting this to Yes serves no purpose.
   Crossref supported (override)	Appears only for collections linked to the Community Zone. If you are the collection contributor, enter a value here to update the collection in the CZ. If you are not the contributor, enter a value here to update your local copy.
   Crossref enabled	Select Yes, No, or Inherit to indicate your preference for using the CrossRef service. Yes – Get the DOI and use it for linking. You must also have your CrossRef information configured properly. See Alma Resolver Augmentation for information about configuring an Alma integration profile for DOI. No – Do not use the functionality related to CrossRef for linking this electronic resource. Inherit – Use the policy as defined by the previous (upper) level in the hierarchy. For a portfolio, the electronic service level policy is used. For an electronic service, the policy defined in Community Zone electronic service (as indicated in the Crossref supported field, above).
   Proxy enabled	Whether a proxy is enabled See Resolver Proxies for information about proxy relationships among portfolios, electronic collections, and services.
   Proxy selected	A proxy profile. When you specify Yes for Proxy enabled, identify which proxy profile is used for authentication (of users outside the library’s network) to access the online database you have created. If you specify Yes for Proxy enabled and you make no selection here, Alma automatically uses the default proxy you configured. The procedure To configure a resolver proxy definition type of integration profile: in the Resolver Proxies section describes how to configure a default proxy profile.
   Availability rules	Select the Service display condition rules link to view the rules automatically created by the system. See Display Condition Rules for more information.
   Link Resolver Plugin
   Link Resolver Plugin	A link resolver plugin, if needed.
   Linking Parser Parameters
   Linking Parser Parameters	The values, if needed, for the parameters configured in the parser parameter fields on the Linking tab. See the table below for more information. For the $$U_SHIBBOLETH parameter, the relevant entity ID must be specified. In addition, the value Yes must be entered for $$SHIBBOLETH.

   Some electronic collections require parameters that are specific to your library. For SFX customers, this information is migrated from SFX. For non-SFX customers, you must enter the values for the electronic collections to which you subscribe.

   See the following table for a description of which parameters require information for which electronic collections. Note that this table is not exhaustive. Additional electronic collections that are not listed in this table may require information for their parameters. For more information, see the SFX Target and Alma E-Collection Configuration Guide and, in particular, the Introducing E-Collection Configuration for Alma chapter of this guide for its usage with Alma.

   Collection	Parameters	Explanation
   ABC CLIO Databases	USERNAME PASSWORD	An ABC representative can provide you with your user name and password.
   CCC (Copyright Clearance Center) service	BILL, ID, INST, MAIL, and SOURCE	A CCC representative can provide you with the details for each of the following linking parameters: BILL – The email address used for billing. MAIL – The email address used for sending an article. SOURCE – The university system code, which is provided by CCC. INST – The campus name code (for example, Fullerton), which is provided by CCC. ID – The libraryUserID of EZProxy users, which is provided by CCC. If the university system and the institute are the same, the Get It Now service expects the SOURCE and INST parameters to have the same value. Testing access to CCC Get It Now services (using the test access action in the staff search results) will not lead the staff user to an article because the electronic resource from which test access is performed is at the journal level.
   Ebook Central Perpetual and DDA Titles	CUST_ID	Library’s code assigned by Ebook Central.
   EBSCO	CUST_ID, OPID	If you add the $$CUST_ID linking parameter, your institution will automatically log in when trying to access articles and journals in the EBSCO platform. If your institution adds your unique linking parameter called $$OPID in addition to the $$CUST_ID, the journal level link will work as above, but the article level links will be generated in the following way (EBSCO's new linking method): nkc.com.pk{OPID}/openurl?prompt=true&{OpenURLcontextObject}  This is the recommended method.  If you only use the $$OPID parameter without the $$CUST_ID, the article level link will be created as above and will work as expected, but the journal level link will lead to the EBSCO login page.  For SSO authentication - enter the value 'yes' in the SSO linking parameters For SHIBBOLETH/ATHENS authentication - enter the value 'yes' in the SHIBBOLETH linking parameters For IP authentication - enter the value 'yes' in the IPAUTH linking parameters For details, see Transition to EBSCOhost New Target Parser - December
   Eureka	CUSTOMER_ID	A Eureka representative can provide you with your customer ID.
   Factiva	NAMESPACE, PASS, USER Or: SID	A Factiva representative can provide your namespace, user, and password information. Or: Specify your XSID value. When linking to Factiva with your XSID, there is no need to provide the other parameters. See the SFX Target and Alma E-Collection Configuration Guide for additional parameter details.
   All Gale Databases	LOC_ID ART DATABASE	A Gale representative can provide you with your institution’s LOC_ID. The ART parameter must be yes. The DATABASE parameter is only relevant for the following collections: Galegroup IT Custom Journals Galegroup IT Custom Newspapers Galegroup Military Intelligence Galegroup Religion Philosophy Collection
   Journals at Ovid	USERNAME PASSWORD	Libraries can connect to Ovid Journals using IP authentication or login credentials. If your library uses a user name and password, provide these values.
   	IPAUTH	If your institution is authenticated by IP authorization, type yes (in lowercase letters) in the Value column. In this case, there is no need to provide a user name and password.
   		For other Ovid parameter information, see the SFX Target and Alma E-Collection Configuration Guide.
   CSA Databases	USERNAME	Provide your library’s user name and access values.
   	ACCESS
   ProQuest Databases	CLIENTID	A Client ID is necessary for users in a collaborative network implementing a Network Zone. In other cases, the Client ID is not necessary for linking to ProQuest databases, but may enable additional services, depending on your institution’s license with ProQuest. Some ProQuest databases ask for CLIENTID, while others for ACCOUNTID. This is the same value in both cases, the ProQuest account ID. A ProQuest representative can provide you with your Client ID. For the Chadwyck electronic collections based on the ProQuest platform, refer to the SFX Target and Alma E-Collection Configuration Guide for parameter details.
   Westlaw	SPONSORCODE	A Westlaw representative can provide you with your customer code.

5. Select the Portfolios tab:
   
   From the Portfolios tab, you can perform the following actions:

   Action	Description
   Add Local Portfolio	To add a local portfolio to the service, select Add and select Add Local Portfolio. The New Portfolio page appears. See Adding a Standalone Portfolio and the New Portfolio Page Options table for more information.  When you have completed the information on the New Portfolio page, select Save and Done. Alma saves the portfolio and refreshes the Portfolios tab of the Electronic Service Editor page with options for activating (and deactivating) the portfolio. You can add the portfolio information later by doing one of the following:
   Load Portfolios	Select an Excel-formatted file to load multiple portfolios. For more information, see Adding, Editing, or Removing Portfolio Information in Bulk
   Add from set	Add portfolios from an existing set. Select to open available sets, then select one. Note that this is not an option for collections that are linked to the Community Zone.
   After adding at least one portfolio, the following additional actions are available These actions are enabled only if the library set in the electronic resource matches the library defined on the user's role scope. For other electronic resources, these actions are disabled. For details, see Library set on electronic resource.
   Actions (for each portfolio)	Select the following operations for a portfolio: Edit – Open the Electronic Portfolio Editor in edit mode. For more information, see Editing a Portfolio Using the Electronic Portfolio Editor. View – Open the Electronic Portfolio Editor in view-only mode. Test Access – Display the portfolio on the Electronic Services page (or when selecting Display in a new window, if direct linking is enabled). When a Vendor website does not support iframe, Test Access displays a blank screen. For such cases, use the Display in new window option. Remove – Delete the portfolio. In the confirmation dialog box, select whether to: Delete the bibliographic record Do nothing Suppress the bibliographic record Deactivate – Deactivate the portfolio. Duplicate – Duplicates the local portfolio information (internal description, PO line, override information such as coverage, authentication note, and public note) from the local portfolio from which you selected this action, and opens the Electronic Portfolio Editor page with the duplicated information for you to edit.
   Activate Selected	Activate the selected portfolios
   Deactivate Selected	Deactivate the selected portfolios
   Deactivate All	Deactivate all portfolios in the list
   Activate All	Activate all portfolios in the list
   Delete Selected	Delete the selected portfolios. In the confirmation dialog box, select whether to: Delete the bibliographic records Do nothing Suppress the bibliographic records
   Tools	Extended Export – Export the list of portfolios with extended information to Excel Excel (Current View) – Export only the fields appearing in the list of portfolios to Excel The export can include inactive (Not Available) portfolios. For more information, see Portfolio Loader. Specific to exporting portfolios from Alma to BrowZine, see Exporting Electronic Portfolios from Alma to BrowZine in the Developers Network.

6. In the Notes tab, you can enter an authentication note (a note related to authentication (to display in the discovery system) and a public note (information about the service (to display in the discovery system). For more information, see Notes Tab.

   When a group setting is defined for an Electronic Collection, a public note defined in the Electronic Service Editor does not trickle down to portfolios. If a group setting is defined, define the public note in the Notes tab of the Collection Editor or in the service-level Group Settings Profile.

7. You can view information about changes to the service on the History tab (for more information, see History Tab). There is no information on this page when the service is first created. Each change includes the following information:

   • Date
   • Operator – The user who made the change.
   • Field Name – The field that was changed. All fields of the Electronic Collection are tracked for changes. 
   • Old Value
   • New Value

8. To restrict access to the resource(s) based on location, select the Group Settings tab and enter the necessary information. You must first configure inventory management groups (see Configuring Distributed Access to Electronic Resources). 

1. Select Add Settings for Group. The Available For Information dialog box appears.

2. Select the group to which to restrict the resource.
3. For Proxy Enabled, select:
   • Yes – Add a proxy when resolving this resource. Specify the proxy in the Electronic Collection Proxy selected.
   • No – Do not add a proxy when resolving this resource.
   • Resource Default – Use the proxy definition from the resource. See Resolver Proxies for information on the hierarchy of proxy relationships among portfolios, electronic collections, and services. The default resource is determined by this hierarchy.

     If using a proxy for resources limited to a specific inventory management group, set this option to 'Yes'. Setting it to 'Resource Default' for a group might not resolve correctly.

4. Add a public name for the resource, and authentication or public notes, as required.

   For public notes limited to a specific inventory management group, always include the campus/library that belongs to this group in the openUrl.

5. Select Save Settings

For an example, see Configuring Distributed Access to Electronic Resources.

• Select Save to save all the entries and changes on the Electronic Service Editor page. The Electronic Collection Editor page appears.
  

  Electronic Collection Editor

  • Review the tabs on the Electronic Collection Editor page and confirm your settings. See the table below for an explanation of the Electronic Collection Editor page tabs and fields.

    Option	Description
    Collection Name	The electronic collection name.
    Collection ID	The electronic collection ID.
    Electronic Collection Description tab: See the Initial Collection table.
    General tab – Summary and Inventory Information section: (Most of this information is relevant only for Database type electronic collections.)
    Electronic collection type	Select a different electronic collection type if you decide to follow a more service-oriented ordering model.
    Type (override)	Appears only for collections linked to the Community Zone. If you are the collection contributor, enter a value here to update the collection in the CZ. If you are not the contributor, enter a value here to update your local copy.
    Interface name	The vendor interface for this database. A link to the vendor interface description is provided when an interface name is entered.
    Interface name (override)	Appears only for collections linked to the Community Zone. If you are the collection contributor, enter a value here to update the collection in the CZ. If you are not the contributor, enter a value here to update your local copy.
    Services	The services information, if it is available.
    Process type	The only value that this field can display is 'Acquisition'. It is populated automatically once you click the Order row action on a Community Zone collection. This indicates that this collection was activated as part of the Acquisition workflow.  In other cases this field is blank.
    Access type	Access type can be specified by one of the following options that identifies the licensing rights for the electronic collection: Current – This is the default option. For the electronic collection that you are creating, this identifies the licensing arrangement for which you are currently subscribing, paying. Perpetual – For the electronic collection that you are creating, this indicates that the titles of the collection have permanent access during the period of a license agreement. Current and perpetual – For the electronic collection that you are creating, this identifies the licensing arrangement that includes both current and perpetual resources. Access type data is also available in Analytics. See Electronic collection access type and Access type (Portfolio) for more information. Access type (Electronic Collection)
    COUNTER Platform	Use this parameter to indicate the platform by which you want usage data tracked for a specific electronic collection for Alma Analytics usage data and cost-per-use reports. The list of options for this parameter comes from the list of platforms included in the loaded COUNTER reports. In order to have values appear in this list, you must have loaded COUNTER reports. Note that if you leave the COUNTER Platform parameter blank, there is no change in the way that the usage data is tracked for Analytics reporting. That is, no platform-specific data is tracked for the electronic collection.
    General tab – Acquisitions and License Information section: (Most of this information is relevant only for Database type electronic collections.)
    PO line	The main PO line created for the database type electronic collection being added. When trying to link an electronic collection to a PO Line, the PO Line must be of type Electronic Collection (Onetime or Subscription). When adding a database type electronic collection, you may skip this option and process the order information later, after saving the database inventory record.
    PO line details	A link to the main PO line details, if available.
    Public access model	Displays the active access model associated with the portfolio, as inherited from the PO line that created the portfolio. Any updates to the access model on the PO line are reflected in this field. You can also change the value of this field, and this determines the active access model of the portfolio. However, changing the access model on the portfolio does not update the access model on the PO line.  In case a PO line of type 'License Upgrade' was added to the portfolio as an additional PO line, the Public Access Model field on the portfolio displays the access model associated with the license-upgrade order. There is an option of disabling the presentation of the access model in the Discovery system via Configuration menu > Fulfillment  > Discovery Interface Display Logic > Other settings. This will disable presentation of the access model in the Discovery system for all electronic resources. To control the presentation of the access model to patrons via Alma Link Resolver, institutions now can use a designated configuration located under Fulfillment > Discovery Interface Display Logic > Other settings. Select the checkbox Enable Display of Access Model to display in Primo the access model information located on the portfolio. The Enable Display of Access Model option is disabled by default. Institutions that want to control the presentation of the access model to patrons via Alma Link Resolver, need to select the Enable Display of Access Model option. See Configuring Other Settings.
    Activation date	The date on which the resource was marked as activated. Note that this is not necessarily the same as Activation from date (defined in the Activation tab).
    Expected activation date	The expected activation date.
    License	The vendor license for the collection that you are adding.
    View license details	A link to the license details when an active license is selected.
    Additional PO Line	A list of any additional PO lines associated with this collection. Select a link to view information about the PO line. To associate other PO lines as additional PO lines for this collection, search for or enter the PO line number in the Quick Add section and select Add PO Line. To remove a PO line as an additional PO line, select Delete in the additional PO line's row.
    General tab – Historical License Information section: This section appears only if a license was defined. Lines are added to this section each time the license changes. Select View to open the License Details page for this license.
    Additional tab – Electronic Collection Information section:
    Source	For future use.
    Source ID	For future use.
    Creator	For future use.
    Alternative title	For future use.
    Electronic Collection Level URL	This is the URL entered for the local electronic collection. Up to 1, characters (longer URLs are trimmed). For a Community Zone record, this may be the URL identified in the Community Zone for the (activated) electronic collection. See Working with Electronic Collection Bibliographic Records and URLs Added to the Community Zone for more information. For a database type of electronic collection, this field and the Additional descriptive information are required for the electronic collection to be active and published to Primo. Both this field and the Additional descriptive information must be specified for the Institution Zone icon to become active.
    Electronic Collection Level URL (override)	This is the URL entered to override the URL provided in the Electronic Collection Level URL field entered for the local electronic collection. See Working with Electronic Collection Bibliographic Records and URLs Added to the Community Zone for more information.
    Electronic Collection is free?	Whether the collection is free.
    Is free (override)	Appears only for collections linked to the Community Zone. If you are the collection contributor, enter a value here to update the collection in the CZ. If you are not the contributor, enter a value here to update your local copy.
    Electronic Collection Proxy Enable	Whether to enable a proxy.
    Electronic Collection Proxy Selected	A proxy profile. When you specify Yes for Electronic Collection Proxy Enable, identify which proxy profile is to be used for authentication (of users outside the library’s network) to access the online collection. If you specify Yes for Proxy enabled and you make no selection here, Alma automatically uses the default proxy. See Resolver Proxies for information regarding how to create a proxy profile. The procedure To configure a resolver proxy definition type of integration profile: in the Resolver Proxies section describes how to configure a default proxy profile.
    Language	The language of the collection.
    Language (override)	Appears only for collections linked to the Community Zone. If you are the collection contributor, enter a value here to update the collection in the CZ. If you are not the contributor, enter a value here to update your local copy.
    Category	The subject that the online collection handles (optional). This field has no functional use.
    Category (override)	Appears only for collections linked to the Community Zone. If you are the collection contributor, enter a value here to update the collection in the CZ. If you are not the contributor, enter a value here to update your local copy.
    Additional descriptive information	The MARC bibliographic record to link to this collection. The MARC bibliographic record selected for this option appears in the discovery (Primo) search results. This is the MARC bibliographic record that the library’s cataloger has created specifically for the collection being added. This field is required for publishing to Primo. This field and Electronic Collection Level URL are required for the database to be active and published to Primo. Both this field and Electronic Collection Level URL must be specified for the Institution Zone icon to become active.
    Number of portfolios	The number of portfolios in the portfolios list. Select this link to open the Porfolios List page connected to the electronic collection.
    Character set	The character set information.
    Additional tab – Services section:
    Add Local Service	Add a service to the electronic collection that you have open. See Adding a Local Electronic Collection, starting with the bullet under step 2 that references the Electronic Service Editor page for more information regarding adding a service.
    Refresh	Use this function to follow the progress of a background job that is deleting services. When you select Refresh, the service information that appears in the Services section is updated. Refresh
    Service rows	The following actions are available for each service row: Edit View Portfolio List - This opens the Portfolios tab on the Electronic Service Editor page. Deactivate Delete This initiates a batch process to delete the service. You are prompted with a Delete confirmation message where you can select how to handle bibliographic records with no inventory when your delete request is processed. Your options are Do nothing, Delete bibliographic record(s), or Suppress bibliographic record(s). Select Confirm to process your delete request, and check the History tab on the Monitor Jobs page (see Viewing Completed Jobs) to view the results of your job. A job submitted confirmation message appears. See Delete Electronic Service Job Report on the Viewing Completed Jobs page for more information.
    Notes tab: For more information, see Notes Tab.
    Authentication note	A note related to authentication (to display in the discovery system).
    Public note	Information about the database (to display in the discovery system).
    Group Settings tab – See the Group Settings tab explanation above in the step for editing the Group Settings tab. Also see Configuring Distributed Access to Electronic Resources.
    	The following changes in this dialog box apply for services: A service does not have a public name Enter any required linking parameter values. These parameters are defined on the Linking tab of the service. The values are used by the OpenURL link resolver to create correct links. For detailed information, see the Library-Specific Parameters table above and the SFX Target and Alma E-Collection Configuration Guide including the Introducing E-Collection Configuration for Alma chapter of this guide for its usage with Alma.
    History tab – Information on this tab is only relevant when editing the electronic collection.
    	This is a read-only tab that displays a list of changes that were made to the electronic collection or the electronic collection's group settings (for institutions where the multi_campus_inventory_management customer parameter set to true). Select one of the following radio buttons to indicate the historical information that you want to view: Portfolio changes Group Settings changes For each change that is saved, the following information appears on the History tab. Only changes made in the UI or by internal system processes appear in this tab; changes made by any other job do not. Date of the change Operator that made the change Group Name    Name of the field that was changed Old (previous) value New value For fields/columns that are blank or empty, a dash appears in the History tab columns. For more information about this History tab, see the History Tab for Electronic Resources video ( mins).
    CDI tab – Except for the Do not share as Full Text available in CDI even if active in Alma field, all other fields on this tab appear only when the collection is indexed in CDI (i.e. the Available for CDI search activation facet is set to Yes). CDI Tab - Collection Indexed in CDI
    CDI Search activation status (only available when the CDI model is Fully Flexible)	This setting controls which records will appear in the Primo ‘Expand’ search (when user selects the Expand beyond the Library collection option). When set to Active, records from the collection will appear in the Discovery expand search. Records will be flagged as No full text available, unless there are full text activations for this collection. For the full text activations, the indication ‘Full text available’ will be shown. When set to Not Active, records from the collection do not appear in the search results at all. Alma collections that you have active, because you subscribe to their full text, will become automatically searchable in CDI. For those collections no separate search activations are necessary. Collections that require a subscription to be searchable (for example, A&I databases) need to be active in Alma to be searchable. Such collections are marked on Alma as Search Rights in CDI: Subscription. Such collections cannot be simply activated for search because of the way the activation is published to CDI. If you subscribe to such collection, you need to activate it in Alma (in the same way you activate a full text collection) or set the collection to Full text in CDI only: Yes to ensure this collection will become searchable in CDI. Note that the word “full text” in “Full text in CDI only” is a bit misleading in the context of A&I databases but this function can still be used for such collections (see details in the “Active for full text in CDI only" section).
    CDI-only full text activation	This option is used when the library does not want to publish the bibliographic records of the collection and its content to Primo or to use the collection in the link resolver. It can be used for all collections that use Link in record type of linking in CDI, regardless of whether the collection has portfolios or not. Content of collections that are using Link in record type of linking in CDI are set to full text available on the collection level. If Do not show as Full Text available in CDI even if active in Alma is selected as well, an error is generated when saving. If you create groups in the CDI Group Settings section, the CDI-only full text activation appears only in the individual groups and is hidden from the institution section. The effect of using this option is: The collections and the portfolio bib records are suppressed in Alma and are not published to CDI. The collection level record is published to CDI in the zero title file with the effect that the collection is set to full text available and is discoverable in CDI.
    We subscribe to only some titles in this collection	Select Yes to indicate a selective subscription (where you subscribe to only part of the content) or No to indicate a non-selective subscription for this collection (where you subscribe to all of the content in the collection). This option is available only for Aggregator/Selective collections (not for Database types of collections where no portfolios exist). The default setting is Yes. Selecting No should be done only in case your subscription is non-selective (for example for aggregator collections or where you subscribe to the full content of the collection) and will cause the Full Text Available indicators to appear for all records in the collection. It is recommended to set the value to No for Link in Record link type of collections as these are typically non-selective subscriptions and this will make sure that also non-ID content is flagged as available. It is recommended to keep the default setting Yes for Linkresolver link type of collections because setting the value to No may result in linking failures, if the collection in CDI contains additional content that is not reflected in the object portfolio list in Alma.
    Do not show as Full Text available in CDI even if active in Alma	Select this option to suppress this collection when publishing holdings information to CDI. As a result, content will not be flagged as Full text available in the filtered search, unless it is also available from another collection where it is active and not suppressed. The collection will still appear on your link resolver, and users can link to the full text when coming from other search engines or platforms.  When a collection is ‘suppressed’, its content is also not searchable in the expand search, unless the collection set to active for search or unless the same content is available from other active collections. This option appears only for collections with either of the following settings: The Available for CDI search Activation field is set to Yes. The Available for CDI search Activation is set to No, but the collection has portfolios in Alma. Results: All portfolios for the collection are removed from the CDI holdings file. This will ensure that the content is not flagged as 'Full text available' unless it is also available from another collection where it is active and not suppressed.  The collection will still appear on your link resolver, and users can link to the full text when coming from other search engines or platforms.  Content from collections where the full text is suppressed is also not searchable in the expand search unless set to active for search or unless the same content is available from other active collections. The local bibliographic records are not affected and are published to the local Primo Index for discovery. Why use this option: Prevent content from certain collections from appearing in Primo results for example for Open Access collections – where you would like to have only the full text active for the link resolver, but you do not want the same full text visible in the filtered search in discovery because it could clutter the result lists for your users.  Prevent duplicate ebook results where bib records are published to Primo local and in addition the CDI records appear in the result list. This option will make sure that the CDI records do not appear in the result list. Note that this will also eliminate the chapter level records in CDI.
    View-Only Fields	The following view-only fields from the registration system are also displayed on the tab: CDI Collection ID – Used when publishing the CDI holdings file of the institution. Number of records – number of records currently indexed in CDI. This number includes all versions (participants) of a resource and is updated for each collection twice a year in Alma. The number that appears for DBID searches in Primo/Primo VE may be smaller because it includes only one version of a resource and does not include records that do not have a subscription for search.. CDI update frequency – estimated update frequency of the collection in CDI. Values can be weekly, monthly, quarterly or yearly. The update frequency is based on the average update frequency of the last 12 months and is updated in Alma for each collection twice a year. Full Text Rights in CDI – values are: Open Access – All collections that do not require a subscription to access full text. Subscription (Collection Level) – All collections that require a subscription for full text and are set to available on the collection level. They do not use the link resolver for selectively setting the collection content to available. Subscription (Linkresolver) – All collections that require a subscription for full text and the availability setting is performed selectively on the item level, based on your link resolver activations.   CDI type - Type of database in CDI. Values can be: A&I Database: Citation-only database. Records from the collection do not provide full text linking in CDI.  However, some of the records from the A&I database may be included in the CDI filtered search, with ‘Full text available’ indication, in case there are active portfolios in Alma from other collections. Full Text Collection: Records from the collection provide full text linking in CDI. Hybrid: Only part of the collection has a direct link to full text on the provider platform. Newspapers – values are: Yes – All collections with content that is available in both the Newspaper Search interface and the Regular Primo search interface. Yes, Newspapers Search only – All collections with content that is available exclusively via the Newspaper Search interface, not via the Regular Primo search interface. No – All collections that are not available using the Newspaper Search interface because they do not contain newspapers. Available for CDI search activation – Yes indicates that at least 80% of the content of the collection is searchable in CDI. No indicates the data in the collection is not searchable or less than 80% of the content is searchable in CDI. For most of the collections, a data feed is received directly from the provider. For collections that are not directly indexed from the provider, CDI will automatically use the metadata from other collections in the index and the content will still be searchable. Provider Coverage - Indicates how a collection is indexed in CDI. If set to ‘Yes’, the collection is indexed with data received directly from provider. If set to ‘No’, we do not get a database directly from the provider, but at least 80% of the content of the collection is covered in CDI by data received from other providers. Resource Types – Lists up to 5 of the most frequently index resource types for the collection. This list is updated in Alma for each collection twice a year. CDI Search Rights – Select Free for all collections whose content can be searched for free or Subscription for all collections that require a subscription for searching their content. CDI collections with Search Rights: Subscription require the patron in Primo VE to be logged in to retrieve search results from the collection. CDI Full Text Linking – Indicates which type of link (collection level or link resolver) is needed to provide full text for a collection. Valid values are Link via Link resolver, Link in record, and Hybrid. For CDI records, in case the CDI full text linking is ‘Link in Record’ – the Alma link resolver is not invoked at all, the linking will use the link from the provider record directly. As a result, any configuration for services in Alma (name of the collection, display rules or sort order of services, as well as note information) is not used. Coverage Percentage - Items that are available for CDI indicate the coverage percentage of the records in CDI. This indicator also includes the last date of calculation for this statistic. This information only displays if the coverage percentage has been calculated. If the date is not populated, it will not be displayed. CDI Last Market Update - Last date that at least one record in the Electronic collection was updated in the CDI index. This field is currently updated quarterly. The CDI Last Market Updateis dynamic by nature, as CDI is continuously updated by many sources on an ongoing basis. Currently, the update frequency of this field is quarterly due to technical challenges. We are working to improve and automate this process, and our goal is to reach a 6-week update cycle by the end of , for all collections which are in CDI.
    CDI activation required – (only available when the CDI model is EasyActive)	With the EasyActive setting, all collections are automatically searchable for the user and do not require search activation, except those listed in the EasyActive collection list. These collections do require activation in Alma (either via the ‘CDI only full text activation’ option or via regular Alma activation) and will in Alma get the indication ‘CDI activation required = Yes’. These collections will meet one of the following criteria: The providers either do not want their content to be searchable automatically or their databases require subscriptions. Some collections are likely to be used only by some institutions. What your users see in the filtered search is fully controlled by your full text activations in Alma. Additional search activations only impact the expanded search. For more information about this option, see: Managing Collections for Discovery with EasyActive

• When you have completed your review, select Save or Contribute to Community (see Community Zone Contribution Guidelines for more information).

This action is enabled only if the library set in the electronic resource matches the library defined on the user's role scope. For other electronic resources, this action is disabled. For details, see Library set on electronic resource.

1. Search for the electronic collection that you want to update.
2. Select Edit Collection from the row actions list. The Electronic Collection Editor page appears.
3. Update the fields on each tab of the Electronic Collection Editor page to match your requirements. For information on all tabs, see the Electronic Collection Editor Tabs and Fields table.
4. Select Save to save your changes to the electronic collection.

This action is enabled only if the library set in the electronic resource matches the library defined on the user's role scope. For other electronic resources, this action is disabled. For details, see Library set on electronic resource.

1. Search for the electronic collection that has the electronic service that you want to update.
2. Select Edit from the row actions list. The Activation tab of the Electronic Service Editor page appears.
3. Update the fields on each tab of the Electronic Service Editor page to match your requirements.
4. Select Save to save your changes to the service.

Adding/changing an Electronic Collection Level URL (override) does not trigger Ongoing Discovery Indexing. The affected records need to be manually re-indexed for the change to take effect in Primo.

1. Open the Electronic Collection Editor page (Resources > Create Inventory > Add Local Electronic Collection).
2. Enter the initial database information. For more information, see the Initial Collection table.
   • For Collection Type, select Database.
   • For Service Type, select None (this is selected by default).
3. Select Save and Continue. The Electronic Collection Description tab in the Electronic Collection Editor appears.
4. Enter the information as described in the Electronic Collection Editor Tabs and Fields table. For the database to be available in Primo, you must enter at least a collection level URL and the additional descriptive information (the bibliographic record) on the Additional tab.
5. After completing the information on the tabs, select Save. The Repository Search page appears with the database record that you added (see the figure below). With this record, you can process other tasks related to the online database such as placing an order.

1. Locate the database type of electronic collection for which you want to place an order.
2. Select Order from the row actions list. The PO Line Owner and Type page appears.
3. Enter the Purchase Type and PO Line Owner and select Create PO Line.
4. Enter the PO line information for the online database. (See Creating PO Lines for additional information regarding these fields.)
5. When you have completed entering the PO line information, select Order Now.

   When you have completed the order, the Purchase Order Lines in Review page appears and your usual acquisitions workflow can be completed.

   Once the order is complete, an electronic resource activation task is automatically added to the Electronic Resource Activation Task List. See Activating Electronic Resources for additional information. For a continuous order, you must select Done for this order in the task list to allow Alma to renew the order.

1. Complete an All titles repository search for the online database.

   Locating the online database inventory record with an All titles search requires that the online database record includes a repository link. The repository link is entered on the Additional tab in the Additional descriptive information option.

2. Select View It from the row actions list.
3. Optionally, select Display in a new window.

To deactivate an electronic collection of type database:

Linking to community is supported only for collections with portfolios.
If your collection does not have portfolios, you can instead delete the collection and activate it from Community Zone. 

1. Search for a local electronic collection that you want to link to the Community Zone.
2. Select Link to Community. The Link Electronic Resources to Community page appears. The page contains a general header with the electronic collection name, type of collection (selective package, aggregator package, or database), and vendor interface name (when available) and the following sections:
   • Local Information – Within this section, the following information is provided:
     • Service type (full text, selected full text, or none)
     • Total number of portfolios
     • Number of local portfolios
   • Community Information – Use this section to identify the name of the electronic collection to which you want to link in the Community Zone. Once you have specified this information, the Type, Interface name, and Service type information is updated based on the information provided by the Community Zone link.
   • Bibliographic Records Configuration – Use this section to identify how you want Alma to use the bibliographic record information available in the Community Zone. If you select Yes and a portfolio match is found in the Community Zone, the bibliographic record associated with the linked portfolio is the Community Zone bibliographic record. If you select No and a portfolio match is found in the Community Zone, the portfolio that is linked to the Community Zone portfolio will use the local bibliographic record. The match routine for this job uses either the ISSN or the ISBN identifier to confirm a match between the local portfolios in the electronic collection being linked with portfolios in the Community Zone.
3. Using the browse capability of the Electronic collection name option, locate the electronic collection in the Community Zone to which you want to link.
4. Select an electronic collection from the list of results.
   The Link Electronic Resources to Community page appears with your selection and related information.

   The fields in the Community Information section and the Bibliographic Records Configuration sections are dynamically updated once you have selected the electronic collection name from the Community Zone.

5. Select Yes or No for the Use the community bibliographic records option and select Link. A dialog box appears with a summary/warnings regarding the linking selections that you made.
6. Review the information in the dialog box and, if everything is okay, select Confirm. Alma displays a success message that the linking job (your request) was submitted. (This is the linking job that Alma automatically runs when you process a Community Zone link request, as described in the previous steps.)

• Book
• Journal
• Dissertation
• Proceeding
• Conference
• Report
• Document - This type is sometimes used for portfolios in electronic collections in the Community Zone when the type is not otherwise know. If you see this type in a collection and believe that it is incorrect, please open a Salesforce case to correct it.
• Series
• Newspaper
• Transcript
• Database
• Wire
• CD-ROM
• Manuscript
• Sound Recording
• Map
• Other Visual Material - Includes slides and pictures.
• Musical Score
• Streaming Video
• Streaming Audio
• Data Set
• Website
• Video
• Master Thesis
• Government Document

• After you add a portfolio, you can locate it using the repository search and link it to a matching portfolio in the Community Zone. For more information, see Link to Community.
• The maximum number of portfolios that an electronic collection can contain is , portfolios. This limit is recommended by Ex Libris for optimum performance. 

1. Open the New Portfolio page (Resources > Create Inventory > Add Local Portfolio).
2. Enter the required portfolio information as described in the following table, when Portfolio Type is set to Standalone. (For a portfolio that is part of an electronic collection, see Adding Portfolios Individually to an Electronic Collection.)

   Field	Description
   Descriptive Information:
   Creation Type	Select to either create a new title or use an existing title.
   Record Type	This parameter is available if Creation Type is Create new title. Select either One Time or Continuing. If you select One Time, the LDR of the created record will have m in pos. 7. If you select Continuing, the LDR of the created record will have s in pos. 7. Note that and pos. 23 will be o (online)
   Placement of new record	This parameter is only available in a collaborative network. For information, see Selecting Where to Create New Bibliographic Records.
   Choose Title	When you select Use an existing title, use the Choose Title parameter to select an existing title. Select the Select from a list icon to open the Repository Search page and select a bibliographic record.
   Title	Enter a new title. This is required when you have selected Create a new title as the Creation Type. This identifies the name of the local portfolio that you are creating and is used to create the title ( field) in the bibliographic record for the portfolio that you are creating.
   Alternative Title 1	Additional information if you created a new title.
   Alternative Title 2
   ISSN
   e-ISSN
   ISBN
   e-ISBN
   Record Format	This field appears only if your institution supports multiple record formats such as MARC 21, KORMARC, UNIMARC, or CNMARC. From the drop-down list, select the type of format to be used when creating the bibliographic record for the portfolio that you are creating.
   Language (new portfolios only)	When creating a new portfolio, select the portfolio language from the drop-down list. The default value is English for MARC 21 and blank/empty for KORMARC, UNIMARC, and CNMARC. Note that this parameter is only available when creating a new portfolio. The language information that you select for this parameter is placed in the new bibliographic record's (positions ) for MARC 21 / KORMARC and the 0# $a for UNIMARC / CNMARC. This parameter is optional. When it is left blank, the system places the following information in the bibliographic record that is created: MARC eng KORMARC: empty (the , positions are left blank) UNIMARC / CNMAR: empty (the 0# $a is left blank)
   General Information:
   Portfolio Type	Select Standalone or Part of an electronic collection. When you select "Part of an electronic collection", a popup opens where you need to select the electronic collection to which to link the portfolio. The selection screen that opens all collections, but allows selecting only the collections that match your role scope(s). For details, see Library set on electronic resource.  When linking a standalone portfolio that has a library set, and attaching it to an electronic collection that has a library set, the portfolio's library is deleted. When the library of the standalone portfolio and the library of the destination electronic collection are different, a warning is displayed on the collection selecting popup (see below): "The portfolio you are about to attach has a different library definition than the selected electronic nkc.com.pk confirmed, the portfolio will inherit the electronic collection's library definition. Note that this action cannot be reversed."
   Electronic Collection (for part of an electronic collection)	Enter the name of the electronic collection to which you want to link the local portfolio that you are creating. Select the Select from a list icon to open the search page and select the electronic collection from the repository. When you create a portfolio as a step in creating an electronic collection, the electronic collection link defaults to the one being created.
   Service (for part of an electronic collection)	Enter the service (such as Full Text) for the selected electronic collection. When you select an electronic collection from the repository, the Service parameter is completed using the service identified for the electronic collection that you selected.
   Interface name (for standalone)	Select a vendor interface for the standalone portfolio. Use the Select from a list icon to search from the available list of vendor interfaces.
   Library	When you choose an electronic collection that this portfolio will be part of, and this electronic collection has a library set, then the "Library" parameter displays the library set on the selected electronic collection in read-only mode. If the collection does not have a library set, then you set a library for the portfolio. You can only select from libraries within your role's scope. For details, see Library set on electronic resource.
   COUNTER Platform	Specify a COUNTER Platform for tracking usage information. See COUNTER Platform for more information.
   Coverage Information:
   Date Information:
   From Year	Coverage field that indicate the content that was purchased/activated. These fields affect service resolution (such as Primo). Coverage appears in the repository search results (available from/until). This identifies the portfolio threshold.
   Until Year
   From Month
   Until Month
   From Day
   Until Day
   From Volume
   Until Volume
   From Issue
   Until Issue
   Embargo/Rolling Year:
   Operator	A moving wall of availability.
   Number of Years
   Number of Months
   Inventory and Linking Information:
   Parser (for part of an electronic collection)	The necessary linking information (if these details are not the same as the electronic collection linking information). Example: EBSCO_HOST::ebsco_am This defaults to the parser information available with the electronic collection that you selected in the General section. For detailed information, see the Library-Specific Parameters table above and the SFX Target and Alma E-Collection Configuration Guide including the Introducing E-Collection Configuration for Alma chapter of this guide for its usage with Alma.
   Service parser parameters (for part of an electronic collection)	The electronic collection’s parser parameters. Example:db_host=poh&ebscohosturl = nkc.com.pk & linkurl=nkc.com.pk & shib=$$SHIBBOLETH & customer_id=$$CUSTOMER_ID This defaults to the service’s parser parameters available with the electronic collection that you selected in the General section.
   Parser Parameters or URL	Enter one of the following optional parameters as needed: The portfolio-level parser parameters (part of an electronic collection), if this setting is different from the Service Parser Parameters previously identified (above). Alma uses the portfolio-level parser/parser parameters when they are different from the service-level parser/parser parameters. The URL (standalone or part of an electronic collection) for accessing the portfolio. This URL overrides the URL created based on the parameters taken from the electronic collection, service, and portfolio.
   Proxy Enabled	Whether the proxy is enabled. See the Resolver Proxies section for information regarding proxy relationships among portfolios, electronic collections, and services.
   Proxy Selected	A proxy profile option from the drop-down list. When you specify Yes for Proxy enabled, you must identify which proxy profile is used for authentication (of users outside the library’s network) to access the online database you have created. If you specify Yes for Proxy enabled and you make no selection from the Proxy selected drop-down list (that is, you leave the option blank), Alma automatically uses the default proxy you have configured. See the Resolver Proxies section for information regarding how to create a proxy profile. The procedure To configure a resolver proxy definition type of integration profile describes how to configure a default proxy profile.
   Availability Status	Whether the portfolio is active or inactive.
   Electronic material type	The electronic material type from the drop-down list of options; see Electronic Material Types.
   Notes:
   Authentication Note	Additional information related to authentication
   Public Note	A note regarding the portfolio that appears to patrons.
   Internal Description	Additional information for staff regarding the portfolio.

3. Select one of the following Save options.:
   • Save and Done – Save the portfolio information and close the New Portfolio page.
   • Save and Create Duplicate – Save the portfolio information and repopulate the New Portfolio page with the same information for you to edit for the next portfolio.
   • Save and Create New – Save the portfolio information and reopen the New Portfolio page for you to enter the next new local portfolio, thereby saving the steps of opening the New Portfolio page again manually.

   To view a video of the Save options, see Efficient Creation of Multiple Portfolios for a Bibliographic Record ( mins).

   Once you save a portfolio, you can test the link access using the OpenURL Link Resolver that displays results on the Electronic Services page. See Using the OpenURL Link Resolver Debugger Tool.

1. Open the New Portfolio page (Resources > Create Inventory > Add Local Portfolio).
2. Enter the required portfolio information as described in the New Portfolio Page Options (Standalone and Electronic Collection) table in Adding a Standalone Portfolio, making sure that Portfolio Type is set to Part of an Electronic Collection and the associated electronic collection and service are specified. (For a standalone portfolio, refer to Adding a Standalone Portfolio.)
3. Select one of the Save options.

1. Create a set of local standalone portfolios.
2. To add the set of standalone portfolios to an existing local electronic collection, do the following or skip to step 3 to add portfolios to a new electronic collection.
   1. Complete a search to locate the existing local electronic collection.
   2. Select Edit Service and continue with step 4 below.
3. To add the set of standalone portfolios to a new local electronic collection:
   1. On the Electronic Collection Editor page (Resources > Create Inventory > Add Local Electronic Collection), enter the Public name for the electronic collection and other details.

      You can specify the service type — Full Text, Selected Full Text, or None — on the Electronic Collection Editor page (eliminating additional steps to make this specification). Note that there is no functional implication to selecting Full Text or Selected Full Text. If None is selected (for databases), portfolios cannot be added.

   2. Select Save and Continue. The Electronic Service Editor page appears.
4. Select the Portfolios tab.
5. Select Add from set. The Add From Set page appears.
6. Search/select the set name (that you created/saved in step 1).
7. Select Submit and select Confirm for the confirmation message. The Electronic Service Editor page shows a job submitted message, and a System Job Notification message is emailed with the job details.
8. Select Save. The Electronic Collection Editor page appears with an electronic collection successfully updated message.
9. Select Portfolio List from the row actions list to view the standalone portfolios added to the electronic collection.

1. Complete a repository search for the electronic collection containing the local portfolio that you want to remove.
2. In your search results containing the local portfolio to remove, select Edit Service.
3. Select the Portfolios tab. The electronic collection contents appear.
4. Select the portfolio you want to remove and select Delete Selected, or select Remove from the row actions list.
5. Select Save.

• Related Portfolios can only be updated using the Portfolio Loader. Creation of Related Portfolios using the Portfolio Loader is not supported.
• This action is enabled only if the library set in the electronic resource matches the library defined on the user's role scope. For other electronic resources, this action is disabled. For details about library inheritance by portfolios, see Library Set on Electronic Resource. 

1. From the Portfolios tab on the Electronic Service Editor page, select Load Portfolios.

   The Activation Wizard File Upload page appears.

2. In the Format field, select the file type you are loading into the Portfolio Loader. For instance, select either the default Portfolio Loader Format (an Excel file) or KBART file.
3. In the Select File section, enter the name and path of the Excel file (with either the .xls or .xlsx extension) or KBART file (with either the .tsv or .xsl extension ) you prepared, or select Browse to select the file.
   

   Select Format and File - Load Portfolios

4. Select one of the following Loading Policy Types in the Select Loading Policy section:
   • Complete – Loads a complete set of portfolios, overwriting any existing portfolios. The following options are available when this is selected:
     • Add local portfolios – Process the portfolios (in the input Excel or KBART file) in the following manner:
       • If a match is found in the Community Zone for the portfolio, the portfolio is added and linked to the Community Zone.
       • If a match is not found in the Community Zone for the portfolio (based on the identifier), a match is attempted in the Institution Zone and, if found, the portfolio is added as a local portfolio in the electronic collection. Otherwise, a new local portfolio record is created and added to the electronic collection.
     • Update portfolios – Update existing local portfolios with the information listed in the Excel or KBART file for the matching portfolios when this option is selected. For portfolios linked to the Community Zone, only parser parameters and coverage information is updated when this option is selected.

       When updating local portfolios using the portfolio loader, the parser is always changed to Bulk:BULK.
       Verify that the URL type (override) is not set for Parser parameters if the Parser parameters (override) value is empty. Otherwise, the service results in an error.

     • Delete portfolios – Select this option to indicate that:
       • If portfolios are in the Community Zone-linked electronic collection and not in the Excel or KBART file, they will be deleted. These portfolios become local and are deactivated.
       • If portfolios are in the Excel or KBART file but not in the Community Zone-linked electronic collection, they will be activated from the Community Zone (if they exist in the Community Zone)
       This differs from how Alma processes the Excel or KBART file contents when the Delete option for the Incremental loading policy type is selected (see the description below).

       The Delete portfolios option provides the following additional options to enable you to specify how you want to handle bibliographic records when deleting portfolios results in bibliographic records without inventory:

       • Delete bibliographic record(s)
       • Suppress bibliographic record(s)
       • Do nothing
   • Incremental – Loads a file that includes only the incremental changes to the portfolio list of a specific electronic collection. With this option, you can load only the portfolios that have been updated since the last load.

     When you choose Incremental, the page refreshes to display the following incremental options:

     • Add New – This option adds new portfolios to existing collections in the following cases:
       • When the electronic collections are linked to the Community Zone and Add New is selected, this operation attempts to match titles in the Excel or KBART file with portfolios of the same collection in the Community Zone, and if found, activates the relevant portfolios. If no match is found, local portfolios are created.
       • When the electronic collection is local and Add New is selected, the portfolio loader adds the titles in the Excel or KBART file as local portfolios.
     • Update – This option updates the details of all electronic collection portfolios that are listed in the file.
     • Delete – When this option is selected, any portfolios that are in the Excel or KBART file that match the portfolios in the electronic collection are deleted from the repository.

       This differs from the Delete portfolios option under the Complete loading policy type (see the description above).

       The Delete option provides the following additional options to enable you to specify how you want to handle bibliographic records when deleting portfolios results in bibliographic records without inventory:

       • Delete bibliographic record(s)
       • Suppress bibliographic record(s)
       • Do nothing
       For this example, select Complete and Add local portfolios.

   For more information on the Alma portfolio loader, see Portfolio Loader.

5. For Record Format, select the type of records to create.

   This field appears only if your institution supports multiple record formats (enabled by Ex Libris).

6. Select the appropriate validation policy, according to the below guidelines:
   • Files up to ~2 MB can be validated online.
   • For files bigger than ~2 MB and up to 10 MB, select the Validate offline option. 
     Select one of these options:
     • Load file if there are no errors – If the validation completes (offline) with no errors, the portfolio records in the Excel or KBART file are uploaded and activated. If any lines have errors, the job completes successfully but no lines are uploaded or activated.
     • Load file – ignore lines with errors – If the validation completes (offline) with errors, the portfolio records in the Excel or KBART file with errors are ignored and the remaining portfolio records are uploaded and activated.
7. Select Next.
   If there are validation errors in the Excel or KBART file, the Activation Wizard File Upload page specifies that errors exist. Correct the errors in your original Excel or KBART file and re-import/upload the file as described in the previous steps.

Uploading KBART Files in the Portfolio Loader

KBART option on the Portfolio Loader

The following options are available:

• Portfolio Loader Format (previously, the only option) - Select to upload an input file in the Excel format. For details, see Portfolio Loader. 
• KBART - Select to upload an input file in the KBART format. 

List of Supported KBART Fields

The following KBART fields are supported by the Portfolio Loader: